docs: reorganize README, add TOC and back-to-top links #35
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jordan Conway <jconway@linuxfoundation.org>
|
OpenTofu plan for prod No changes. Your infrastructure matches the configuration.✅ Plan applied in Tofu Apply #35 |
Signed-off-by: Jordan Conway <jconway@linuxfoundation.org>
Signed-off-by: Jordan Conway <jconway@linuxfoundation.org>
zxiiro
previously approved these changes
Aug 28, 2025
Signed-off-by: Jordan Conway <jconway@linuxfoundation.org>
Also add `.idc.` to the Meta runners excludes list. Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Signed-off-by: Jordan Conway <jconway@linuxfoundation.org>
Signed-off-by: Jordan Conway <jconway@linuxfoundation.org>
zxiiro
approved these changes
Aug 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR reorganizes the README for better flow, adds a linked Table of Contents, and inserts "Back to top" links at the end of each major section.\n\n- Reordered sections (Overview → Prereqs → Structure → Configuration → Usage → Monitoring/Alerts → Deployment → Access → Security → Troubleshooting → Contributing)\n- Added Table of Contents with deep links\n- Added Back to top links for navigation\n- Kept markdownlint compliance (≤80 chars, spacing around lists/fences)\n\nSigned-off-by: Jordan Conway jconway@linuxfoundation.org