47 bytes, text/x-phabricator-request
|Details | Review|
Our in-tree documentation is very flat, every entry in SPHINX_TREES is added to the root toctree: https://firefox-source-docs.mozilla.org/ This leads to a long list of random and in-cohesive pages that don't have anything to do with one another. If we want firefox-source-docs to supplant MDN, we need the ability to organize all these different sections by category that have their own landing page (like we have on MDN). The root toctree should only have a handful of top-level categories (things like "Firefox", "Build", "Developer Workflow", "Localization", etc). Each category should have something of a landing page that explains what it contains and links to the subsections within. I haven't looked into how we might implement this, but a very very rough idea might be do something like this: /testing/moz.build: SPHINX_TREES['automated_testing'] = 'docs' /testing/mochitest/moz.build: SPHINX_TREES.automated_testing['mochitest'] = 'docs' This would put /testing/docs under the root toctree, and nest /testing/mochitest/docs under the "Automated Testing" category's toctree.
Assignee: nobody → ahal
Status: NEW → ASSIGNED
Pushed by email@example.com: https://hg.mozilla.org/integration/autoland/rev/19b949191e5c [doc] Don't add doctrees nested under other doctrees to the root index r=nalexander
You need to log in before you can comment on or make changes to this bug.