noxsios / bb-docs-compiler

Documentation compiler / assembler for the Big Bang product by Platform One

https://razzle.cloud

📞 Contact

curl -sL meta.razzle.cloud | jq   

or

irm meta.razzle.cloud | ConvertTo-Json   

bb-docs-compiler's Issues

Fix broken nav on `bigbang/values`

https://bb-docs-compiler.vercel.app/bigbang/values

Look at sidenav + topnav links

Add a --pre-release X flag

Allow building using a release-1.XX branch as the source of truth instead of a Big Bang release tag. This allows release engineers to build during the RE process and push. Also write accompanying docs to go into RE checklist.

Grab release notes on build

Instead of providing a link, cURL the release notes and put into docs/release-notes.md

show error if linkchecker cannot locate file

Instead of blindly patching, should first check if file exists in repo (at true location)

bb-docs-compiler/docs-compiler/repo.py

Line 152 in cf0fada

f"INFO - Patching broken relative link in '{md}': '{p}' --> {upstream_path}"

Restructure to work with new Docs Design update

Docs Design update has broken overall flow + structure, have to refactor.

https://repo1.dso.mil/platform-one/big-bang/bigbang/-/merge_requests/1729/

Add a --no-build option

Add an option to build, spit out the MD files, but not run mkdocs, this should create a multifolder structure if run w/ -l n where n > 1

Remove .pages from `base`

Move .pages files from base to Big Bang's docs folder. This allows for better clarity on source of truth for navigation.

handoff

With only two weeks left, it is time to perform hand-off.

With this, a comprehensive code review will take place to remove ambiguity, and allow for future additions + easier development.

AC:

• Code review
• Add comments where needed in code
• Verify user + developer documentation is sufficient

Make release notes nav update process more performant

Make dynamic / find https://github.com/Noxsios/bb-docs-compiler/blob/main/docs-compiler/cli.py#L44