1419951 - [docs] Create better documentation documentation

Status: NEW

(Firefox Build System :: General, enhancement)

Description

[Andrew Halberstadt [:ahal]]

We currently have a blurb about how to add documentation here:
https://firefox-source-docs.mozilla.org/index.html?highlight=sphinx_trees#managing-documentation

I don't want to re-write the entire sphinx documentation, but it would be good to expand this to also touch on how to actually write the docs. This could include:

* High level overview of sphinx concepts
* Some examples
* Links to sphinx docs/tutorials
* Explanation of installed extensions
etc.

Comment 1

[Rayann Tedds]

Hiya,

I am currently looking for bugs to fix as part of my Open Source Development module at Coventry University and I am interested in developing this bug.

Please could you assign this task to me and give me more information.

This is my first bug fix and any help would be appreciated.

Thank you.

Comment 2

[Andrew Halberstadt [:ahal]]

Hi Rayann,

This bug is about documentation (no coding) and probably isn't a great bug for a contributor. Documentation requires an in-depth knowledge of the system being documented and is best left to a domain expert. Were you looking for a coding problem instead? If so, you might be able to find one at:
https://www.joshmatthews.net/bugsahoy/