Reorganize documentation and expand setup/configuration guidance - #49
Merged
Conversation
README: document the repository layout and a full local-development workflow (prerequisites, building the backoffice client, running the sample site with mock connections, tests, and the docs site), and note that a plain sample build does not rebuild the client. Also surface the key documentation pages up front. Docs site: add a "Understanding your reports" guide describing the dashboard controls, metrics and comparison, breakdowns, events, feature flags, filtering/drill-downs, and document-scoped reports, and link it from the overview and guides navigation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM
Extract the repository layout, local-development setup, and contributing workflow from the README into a dedicated CONTRIBUTING.md, which GitHub surfaces automatically in the contribution UI. The README keeps the consumer-facing install and provider content (it is also the NuGet package readme) and links to CONTRIBUTING.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM
Bring the provider credential key names, configuration precedence, the package settings table, and a configuration-only connection example into the README so it stands on its own, while keeping a short set of links to the documentation site for the fuller detail. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM
…uide Replace em and en dashes with colons, periods, or parentheses so the documentation uses plain ASCII punctuation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM
Slim the package-settings table to the real tunables (the provider credential keys are already covered under "Configure a credential"), replace the configuration-only JSON bootstrap with a pointer to the docs, and add two clarifications developers ask for: the site must already collect analytics, and non-admin editors need the Analytics section granted to their user group. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM
Restructure the troubleshooting connection section into an "any connection" table plus Vercel and Plausible subsections, and point the provider reference pages at those anchors instead of repeating the error interpretations. Link the reports guide from the quickstart's next steps, correct the report list on the overview (no "routes" card), remove a redundant permissions line in the document analytics guide, and drop a stray em dash from the quickstart. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Point the Vercel and Plausible entries in the providers table at the documentation site's provider pages, which in turn link out to the upstream provider docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM
The "Settings screen is the normal way to manage connections" line repeats what the lifecycle section already conveys, so the page now opens directly with configuration precedence. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM
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
2 participants
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
This PR significantly reorganizes and expands the README and documentation to provide clearer setup instructions, detailed configuration guidance, and better-structured reference material. The changes move documentation from a single reference link to comprehensive inline guides while maintaining the external documentation site as a deeper resource.
Key Changes
apps/docs/docs/guides/reports.mdxdocumenting dashboard controls, metrics, breakdowns, events, feature flags, filtering, and drill-down capabilitiesNotable Details
https://claude.ai/code/session_018Djq2PSepUad9EnobYK3TM