Repository navigation
Shorten README and organize detailed user guides - #7
Merged
Merged
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
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.
The 2,054-line README combined the introduction with nearly every usage guide and reference table. Reduce it to a 109-line entry point with installation, guided setup, discovery previews, an agent-workspace example, and a task-oriented documentation table.
Move detailed setup, discovery, authentication, configuration, reconciliation, backups, archives, workspaces, launchers, scheduling, shell integration, and operations into linked user guides with a documentation index. Preserve all 15 original YAML examples and the other usage examples. Keep the existing spec, security, and release docs, move the package code map into the architecture guide, and consolidate development commands into CONTRIBUTING.md. Update incoming links and the contributor guidance for where configuration tables belong.
Validation:
The Forgejo-backed provider tests require Docker, which is unavailable here; the existing pull-request workflow runs that coverage.