Final repository polish: discoverability, consistency, and CI - #3
Merged
Merged
Conversation
- README: retitle Features -> Key Takeaways and Repository Structure -> Repository at a Glance (added a quick-facts table), tightened for first-screen scannability without expanding scope. - Fix two Iris Xe wording inconsistencies for a single convention. - Export the architecture Mermaid diagram to a static PNG and reference both versions from docs/architecture.md. - Add docs/github-setup.md (manual GitHub configuration checklist) and docs/compatibility.md (tested-version matrix, TODOs where unmeasured). - Add a minimal docs-lint GitHub Actions workflow (markdown formatting + link check, no build/test steps) and minimal issue templates. - Cross-link the new docs into README, hardware.md, troubleshooting.md, and CONTRIBUTING.md; fix the handful of pre-existing lint findings surfaced while wiring up the lint job. - Append a JOURNAL.md entry and a CHANGELOG.md v1.5 milestone per AGENTS.md's documentation update rules.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Repository at a Glance (added a quick-facts table), tightened for
first-screen scannability without expanding scope.
both versions from docs/architecture.md.
docs/compatibility.md (tested-version matrix, TODOs where unmeasured).
link check, no build/test steps) and minimal issue templates.
and CONTRIBUTING.md; fix the handful of pre-existing lint findings
surfaced while wiring up the lint job.
AGENTS.md's documentation update rules.