Resolve "Follow-on Follow-on Docs Design update"
Closes issue #1272 (closed)
In a further effort to consolidate and streamline docs I propose:
- move
./Packages.md
todocs/packages.md
- add
.pages
to each directory indocs
that needs nav re-mapping, this allows for mkdocs awesome pages plugin to better build the site navigation. I have code written / some boilerplate in bb-docs v2, but I want to get away from that and consolidate all the docs sources of truth within Big Bang's core repo. This is becausemkdocs
(and any other docs generator) will use the first#
(H1 tag) on a document to build its navigation title; ex:docs/.../sample-prod-config.md
will show up as Big Bang Production Configuration on the site navigation when a much better title would be Sample Prod Config. - Fix file naming conventions to be
lowercase
anddash
(-
) as word separators - Fix page titles
- Restructure
docs/understanding-bigbang/package-architecture
to bring packages out of individual dirs
For easier viewing of the improved navigation, explore this --> https://bb-docs-compiler.vercel.app/
^ built w/ bb-docs-compiler
v2.0
Edited by razzle
Merge request reports
Activity
added kinddocs label
assigned to @razzle
added 12 commits
- 3bf9a8f3 - move Packages.md, add .pages to docs/developer/**, add root docs/.pages
- 216ab24b - fix file names
- 4a1cc9ad - bulk rename package-architecture files
- b6f786ff - fix packages.md links
- eaae824c - remove Big Bang from H1
- 63947a05 - remove Big Bang from H1
- 552cb64f - add .pages where needed into docs/guides
- 626c90bb - fix links
- 49cf8155 - add .pages where needed into docs/prereq, move pod-usage-in-grafana to using-bigbang
- 6b30afca - add .pages where needed into docs/understanding-bigbang
- a75b87ba - fix links
- 688888f1 - remove refs to charter
Toggle commit listadded statusdoing label
requested review from @micah.nagel, @ryan.thompson.44, and @tsiddique1
added 2 commits
added 14 commits
-
abd1ff7e...fe2eb70d - 12 commits from branch
master
- 89088c20 - Merge branch 'master' into 1272-draft-follow-on-follow-on-docs-design-update
- 15dbbec5 - move nexus architecture
-
abd1ff7e...fe2eb70d - 12 commits from branch
added statusreview label and removed statusdoing label
- Automatically resolved by razzle
Please register or sign in to reply