Repository navigation
docs: rewrite README as a landing page and move deep guides to docs/ - #82
Merged
Merged
Conversation
- Lead with what the project does, why it is different, and a Quick start; release notes now live only in CHANGELOG.md. - Add the missing `npx playwright install chromium` step (npm install does not download it, and the slideshow renderer needs it) and the OAuth test-user step behind 403 access_denied sign-ins. - Correct the media fallback description, the extension examples (real provider presets instead of an uninstalled SDK and a nonexistent contentTypes object), the project structure, the schedule, and the troubleshooting table, which now covers the issues raised in Discussions. - Move the feature walkthroughs to docs/features.md and the API examples plus a full route reference to docs/api.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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 README had grown to 628 lines. It opened with about 40 lines of release notes, so the pitch and Quick start were buried under about 15 long feature walkthroughs. This rewrites it as a landing page (313 lines) and moves the detail into
docs/without dropping any of it.New README order: what it is → why it's different → Quick start → how it works → features (one line each, linking to the guide) → providers → configuration → automation → API → troubleshooting → project structure → extending → contributing / built by / license.
Accuracy fixes found while rewriting
npm installnever downloads Playwright's Chromium, and the local slideshow needs it to render. Quick start and troubleshooting now includenpx playwright install chromium.Error 403: access_denied(Discussion Denied at the YouTube stage #25), and enabling the YouTube Analytics API, which the analytics agent calls.@anthropic-ai/sdk(not a dependency) from a file that doesn't exist, and the "custom content types" snippet pointed at acontentTypesobject that isn't in the code. Both are replaced with the real extension points.DEBUG_MODE, which nothing reads. It now usesLOG_LEVELandNODE_ENV.schedules/daily-automation.js.Moved, not removed
docs/features.md: every feature walkthrough from the old README, lightly edited, plus the full automation schedule and the privacy notes.docs/api.md: the curl examples, plus a reference table for all routes inindex.js.CHANGELOG.md.The launch-gate comment (a real dashboard demo only) is kept, and the mascot image stays out, as decided in
0fca2df. The ConstructionBids.ai line moves from Acknowledgments to "More from darkzOGx".Test plan
#anchorin README.md, docs/features.md and docs/api.md resolves (checked with a script)index.js; experiment and automation actions match the handlersnpm run lintpasses🤖 Generated with Claude Code