Re: PSA: Improvements to infrastructure underpinning `firefox-source-docs`

2019-08-27 Thread James Graham
On 27/08/2019 16:24, Andrew Halberstadt wrote: RST is foreign to most It turns out* that firefox-source-docs also supports markdown format, so if you have existing docs in that format, or simply feel like needing to learn ReST is a significant impediment to writing docs, that option is availab

Re: PSA: Improvements to infrastructure underpinning `firefox-source-docs`

2019-08-27 Thread Nicholas Nethercote
I recently wrote my first firefox-source-docs and I was surprised and impressed by one thing in particular: when you run `./mach docs` or `./mach docs ` it opens a Firefox instance that shows the generated HTML, and it *also* starts up a server that automatically regenerates and reloads that HTML e

Re: PSA: Improvements to infrastructure underpinning `firefox-source-docs`

2019-08-27 Thread Andrew Halberstadt
We have some *very* basic documentation here: https://firefox-source-docs.mozilla.org/#managing-documentation But it's not good enough and is missing all of the features outlined here. I've filed bug 1576912 to make these docs better. Shivam a

Re: PSA: Improvements to infrastructure underpinning `firefox-source-docs`

2019-08-27 Thread David Teller
That sounds useful :) Do we have any documentation on how to add documentation? ___ dev-platform mailing list dev-platform@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-platform

Re: PSA: Improvements to infrastructure underpinning `firefox-source-docs`

2019-08-27 Thread Andrew Halberstadt
Forgot to mention, if you run into any bugs using this infrastructure, file under `Firefox Build System :: Generated Documentation`. If you have feature requests or ideas to improve the system, please file a bug and make it block the first-class-docs