docs: comprehensive documentation overhaul#18
Merged
Conversation
README: - Restructure for newcomer readability with How It Works grouped by theme, See It In Action screenshot showcase, and paper citations - Remove Architecture diagram section (defers to docs/architecture/) - Remove references to gitignored proposals/ and roadmap/ directories - Fix Redis version: 7 to 8 (matches docker-compose.yml) - Add docs/README.md as documentation index QUICKSTART.md: - Fix BMAS_NODE_KEY example to match .env.example CONFIGURATION.md: - Fix blackboard_v2 default: true to false (matches config.py) - Fix ports.dashboard: required to optional with default 9321 Architecture README: - Fix Redis image: redis:7-alpine to redis:8-alpine - Add PatchBoard paper to References Design System DESIGN.md: - Fix breadcrumb link depth - Fix invalid ABSTRACT alert type to NOTE - Fix route table: blackboard to mission, remove cost, add artifacts - Rewrite file organization tree to match actual 45-file codebase - Update ASCII layout diagram tab names - Rename DebateList to DebateThread (actual component name) - Fix Tailwind reference to CSS Housekeeping: - Gitignore and untrack ad-hoc scripts - Add 5 screenshots to docs/screenshots/ All 8 CI checks pass.
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
1 participant
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.
Summary
Complete documentation audit and overhaul across all non-gitignored docs. Every claim was cross-referenced against the actual codebase.
Changes
README.md
docs/architecture/)proposals/androadmap/directoriesDocumentation Accuracy Fixes
BMAS_NODE_KEYplaceholder wrong.env.exampleblackboard_v2defaulttruefalse(matchesconfig.py)ports.dashboardmarked required93217-alpine8-alpine(matches compose)[!ABSTRACT]alert[!NOTE]Housekeeping
docs/README.mdas documentation indexdocs/screenshots/generate_icons.py,rebuild.sh)Verification
All 8 CI checks pass: