docs: restructure documentation for better navigation #26
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
- Rewrite README.md with clear navigation for three purposes: 1. Understanding the worlddriven idea (links to philosophy docs) 2. Architecture overview (links to new ARCHITECTURE.md) 3. Repository management (REPOSITORIES.md functionality) - Add ARCHITECTURE.md with: - System overview diagram - Component descriptions (core, webapp, documentation) - GitHub Apps explanation - Data flow diagrams (PR voting, migration, org sync) - Voting algorithm documentation - Update github-apps/README.md: - Link to architecture docs - Document backend implementation endpoints - Update worlddriven-migrate.json manifest: - Add installation event (fires on initial app install) - Keep installation_repositories event (fires on repo additions)
Contributor
🤖 Worlddriven Status📊 Live Status Dashboard🗓️ Merge Date: 2026-01-07 at 09:21:55 UTC (today) 🎯 Want to influence when this merges?Your review matters! As a contributor to this project, your voice helps determine the merge timeline. How to review:
Your options:
💡 Pro tip: The more contributors who agree, the faster this gets merged! 📊 View detailed stats on the dashboard 📋 Recent Activity• 2026-01-06, 08:06:16 - Pull request opened This comment is automatically updated by worlddriven |
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
Restructures the documentation to better serve three key purposes:
Changes
README.md
ARCHITECTURE.md (new)
github-apps/README.md
worlddriven-migrate.json
installationevent (fires on initial app install with repos)installation_repositoriesevent (fires when repos added later)Why
The documentation was philosophy-heavy but lacked practical navigation. Visitors could understand WHY worlddriven exists but not HOW to use it or how the system works.
This restructure provides clear entry points for different audiences while preserving the detailed philosophical content in dedicated files.