Repository navigation
docs: split the long README into a short overview plus docs/ - #131
Merged
Merged
Conversation
Move configuration, OAuth, REST/MCP, AI quickstart, dashboard, and development details into docs/. Keep a short README with palette-first install, a quick start, and a docs table. Use absolute GitHub URLs in the README so links work on npm and flows.nodered.org.
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.
Summary
The root README was 600 lines and hard to scan, including on npm and flows.nodered.org. This change keeps a short overview (about 120 lines) and moves the detailed sections into
docs/.npm install, then a short note on GitHub pre-release.tgzassets./ai-access, creating a token, and choosing MCP or a GET link.https://github.com/com55/node-red-ai-access/blob/main/...links so they work outside the repo.docs/configuration.md,docs/oauth.md,docs/rest-api.md,docs/ai-quickstart.md,docs/dashboard.md, anddocs/development.md.docs/README.mdis updated as the documentation index. Existing generated docs anddocs/releasing.mdare unchanged.Docs-only; no code changes.
Test plan
docs/resolve.yarn type-check,yarn lint,yarn format:check,yarn check:mcp-tools,yarn check:errors, andyarn test(1371 tests) pass locally.