-
Notifications
You must be signed in to change notification settings - Fork 1.2k
docs: consolidate to user-facing guide only (removes duplicates and legacy flat docs) #1029
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
927daef
Merge pull request #869 from rtk-ai/develop
aeppling 51939a5
chore(master): release 0.34.2
github-actions[bot] b812a0e
Merge pull request #926 from rtk-ai/release-please--branches--master-…
aeppling bff0258
Merge pull request #934 from rtk-ai/develop
aeppling e51be7a
chore(master): release 0.34.3
github-actions[bot] 45d8dca
Merge pull request #974 from rtk-ai/release-please--branches--master-…
aeppling 9c9879c
docs: add interface contract and Phase 0 stubs for docs reorganization
FlorianBruniaux 25438b2
docs(guide): add 11 Phase 1 guide pages — full MVP content
FlorianBruniaux 974db2f
docs(phase-4): complete reference, architecture tabs and remaining co…
FlorianBruniaux a94e949
docs: consolidate to user-facing guide, remove duplicates and legacy …
FlorianBruniaux f5e7a41
Merge branch 'develop' into feat/refac-doc
aeppling 6e55f89
docs: address Adrien's review — structure, missing content, agents
FlorianBruniaux 6938a9d
docs: fix broken README links and reduce redundancy, point to docs site
FlorianBruniaux cea6e20
docs: add Star History and StarMapper to README
FlorianBruniaux File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # RTK Documentation — Interface Contract | ||
|
|
||
| This directory contains user-facing documentation for the RTK website. | ||
| It feeds `rtk-ai/rtk-website` via the `prepare-docs.mjs` pipeline. | ||
|
|
||
| **Scope**: `docs/guide/` is website content only. Technical and contributor documentation | ||
| lives in the codebase (distributed, co-located pattern): | ||
| - `ARCHITECTURE.md` — System design, ADRs, filtering strategies | ||
| - `CONTRIBUTING.md` — Design philosophy, PR process, TOML vs Rust | ||
| - `SECURITY.md` — Vulnerability policy | ||
| - `src/*/README.md` — Per-module implementation docs | ||
| - `hooks/README.md` — Hook system and agent integrations | ||
|
|
||
| ## Structure | ||
|
|
||
| ``` | ||
| docs/ | ||
| README.md <- This file (interface contract — do not remove) | ||
| guide/ -> User-facing documentation (website "Guide" tab) | ||
| index.md | ||
| getting-started/ | ||
| installation.md | ||
| quick-start.md | ||
| supported-agents.md | ||
| what-rtk-covers.md | ||
| analytics/ | ||
| gain.md | ||
| configuration.md | ||
| troubleshooting.md | ||
| ``` | ||
|
|
||
| ## Frontmatter (required on every .md) | ||
|
|
||
| Every markdown file under `docs/guide/` must include: | ||
|
|
||
| ```yaml | ||
| --- | ||
| title: string # Page title (used in sidebar + search) | ||
| description: string # One-line summary for search results and SEO | ||
| sidebar: | ||
| order: number # Position within the sidebar group (1 = first) | ||
| --- | ||
| ``` | ||
|
|
||
| The `prepare-docs.mjs` pipeline validates this at build time and fails fast | ||
| if frontmatter is missing or malformed. | ||
|
|
||
| ## Conventions | ||
|
|
||
| - **Filenames**: kebab-case, `.md` only | ||
| - **Subdirectories**: become sidebar groups in Starlight | ||
| - **Internal links**: relative (`./foo.md`, `../configuration.md`) | ||
| - **Diagrams**: Mermaid in fenced code blocks | ||
| - **Code samples**: always specify the language (`rust`, `toml`, `bash`) | ||
| - **Language**: English only | ||
| - **No `rtk <cmd>` syntax**: users never type `rtk` — hooks rewrite commands transparently. | ||
| Only `rtk gain`, `rtk init`, `rtk verify`, and `rtk proxy` appear as user-typed commands. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| { | ||
| ".": "0.34.1" | ||
| ".": "0.34.3" | ||
| } |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR description says “No existing files were modified” and “All changes are additive”, but this PR changes the crate version (and also updates CHANGELOG/Cargo.lock/release manifest). If the version bump is intentional, please update the PR description; otherwise, consider dropping these release/version changes from this docs-only PR.