Skip to content

Add comprehensive documentation for architecture and data systems - #18

Merged
NotReeceHarris merged 1 commit into
mainfrom
develop/initial-documentation
Jul 21, 2026
Merged

NotReeceHarris merged 1 commit into
mainfrom
develop/initial-documentation

Conversation

@NotReeceHarris

Copy link
Copy Markdown
Owner

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 main README.md is updated to direct users to these resources.

Documentation additions and improvements:

  • Added a new docs/ directory with a central README.md that links to detailed documentation on architecture, data syncing, reputation, and the archive.
  • Updated the main README.md to reference the new documentation for in-depth information.

Deep-dive guides:

  • Added docs/architecture.md explaining the client-side SPA design, API/data layers, authentication, caching, configuration, and trust model.
  • Added docs/data-sync.md detailing the GitHub Actions workflow for data synchronization, including a flow diagram, rationale for recompute/force-push, branch protection, and data freshness.
  • Added docs/reputation.md describing the optional reputation system, how rep is earned, stored, displayed, and enforced, with configuration examples and caveats.
  • Added docs/archive.md explaining the optional read-only archive mode for anonymous browsing, what data is stored, how the SPA switches data sources, and constraints.

@NotReeceHarris NotReeceHarris self-assigned this Jul 21, 2026
@NotReeceHarris NotReeceHarris added the documentation Improvements or additions to documentation label Jul 21, 2026
@github-actions

Copy link
Copy Markdown

🧪 Test coverage

File                           Stmts %  Branch %  Funcs %  Lines %
-----------------------------  -------  --------  -------  -------
oauth-proxy/worker.js              100       100      100      100
src/lib/archive/client.ts          100       100      100      100
src/lib/cache.ts                   100       100      100      100
src/lib/config/index.ts            100       100      100      100
src/lib/config/schema.ts           100       100      100      100
src/lib/github/api.ts              100       100      100      100
src/lib/github/auth.svelte.ts      100       100      100      100
src/lib/rep/engine.ts              100       100      100      100
src/lib/rep/ledger.ts              100       100      100      100
src/lib/ui.svelte.ts               100       100      100      100
src/lib/utils.ts                   100       100      100      100
TOTAL                              100       100      100      100

@NotReeceHarris
NotReeceHarris merged commit b37040e into main Jul 21, 2026
4 of 5 checks passed
@NotReeceHarris
NotReeceHarris deleted the develop/initial-documentation branch July 21, 2026 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant