docs: improve README and add documentation pages#85
Merged
unhappychoice merged 1 commit intomainfrom Apr 5, 2026
Merged
Conversation
…eshooting Restructure README: add Cost section, remove redundant LLM Providers and URL Structure sections, streamline Prerequisites into What You Need. Add four new documentation pages: - how-it-works.md: pipeline overview, data flow, collection details - customization.md: post-setup configuration reference - faq.md: cost, privacy, limitations, cleanup - troubleshooting.md: workflow failures, missing data, setup errors Move 'Generating a Report Manually' from README to manual-setup.md. Closes #71
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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
Closes #71
docs/how-it-works.md: pipeline overview, data flow, why daily fetch exists, what gets collecteddocs/customization.md: post-setup configuration reference (site title, language, timezone, LLM provider, custom domain, schedule, version pinning)docs/faq.md: cost, privacy, limitations, cleanup (16 questions)docs/troubleshooting.md: workflow failures, missing data, setup errors, GitHub Pages issuesdocs/manual-setup.md