Repository navigation
Add comprehensive documentation for architecture and data systems - #18
Merged
Merged
Conversation
… reputation system, and read-only archive
🧪 Test coverage |
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.
This pull request introduces comprehensive documentation for the project, providing deep dives into the architecture, data syncing, reputation system, and the read-only archive. The new
docs/directory contains detailed guides that explain how the system operates, how data is managed and synchronized, and how optional features like reputation and anonymous browsing work. The mainREADME.mdis updated to direct users to these resources.Documentation additions and improvements:
docs/directory with a centralREADME.mdthat links to detailed documentation on architecture, data syncing, reputation, and the archive.README.mdto reference the new documentation for in-depth information.Deep-dive guides:
docs/architecture.mdexplaining the client-side SPA design, API/data layers, authentication, caching, configuration, and trust model.docs/data-sync.mddetailing the GitHub Actions workflow for data synchronization, including a flow diagram, rationale for recompute/force-push, branch protection, and data freshness.docs/reputation.mddescribing the optional reputation system, how rep is earned, stored, displayed, and enforced, with configuration examples and caveats.docs/archive.mdexplaining the optional read-only archive mode for anonymous browsing, what data is stored, how the SPA switches data sources, and constraints.