Skip to content

docs: rebuild Architecture chapter - #236

Closed
pgarciagon wants to merge 1 commit into
devfrom
codex/update-architecture-docs
Closed

docs: rebuild Architecture chapter#236
pgarciagon wants to merge 1 commit into
devfrom
codex/update-architecture-docs

Conversation

@pgarciagon

Copy link
Copy Markdown

Summary

  • Rebuild the public Architecture chapter around the current Koinos microservice topology.
  • Fill the service pages, add REST, reorganize navigation, and clarify smart-contract execution, serialization, resources, system calls, ABI, and Proof of Burn.
  • Add a tracked internal source foundation and implementation plan under drafts/architecture; these files remain outside the published MkDocs content.

Technical baseline

  • koinos/koinos deployment bundle commit 821674672e699bf56e94d7c0e8bce122e83d1482.
  • Coherent versioned service revisions from that bundle and koinos-proto v2.6.0.
  • Current official system-contract repositories for Proof of Burn, VHP, ABI, and resource behavior.
  • Historical Koinos One microservice notes used only as structural source material; stale operational details were not imported.

Validation

  • npm run docs:links: passed; two documented pre-existing exceptions remain.
  • MkDocs build: passed.
  • Strict MkDocs check: no new warnings; it stops on the same two pre-existing issues: missing nav target exchanges/jsonrpc.md and missing index.md target interacting/koilib.md.
  • External Architecture links: 50 unique URLs checked successfully.
  • Immutable source-link audit: passed for all public Architecture Koinos source links.
  • Desktop and mobile review: all 20 public Architecture routes checked at 1440x900 and 390x844; no horizontal overflow, broken images, or console errors.
  • Internal-draft exclusion scan: passed; no draft markers are present in the generated site.
  • git diff --check: passed.

Deliberately deferred

  • Node operating procedures, ports, backup and recovery workflows.
  • Privileged system-contract implementation detail and executable irreversible actions.
  • Teleno, TLN, monolithic architecture, and unverified historical parameters.

This PR is intentionally left as a draft targeting dev.

@netlify

netlify Bot commented Jul 25, 2026

Copy link
Copy Markdown

Deploy Preview for koinos-documentation ready!

Name Link
🔨 Latest commit 8fd77d7
🔍 Latest deploy log https://app.netlify.com/projects/koinos-documentation/deploys/6a64c5f65101b900080328e4
😎 Deploy Preview https://deploy-preview-236--koinos-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@pgarciagon

Copy link
Copy Markdown
Author

Superseded by draft PR #238, which consolidates Node Operators, Architecture, Resources, and the complete four-chapter baseline report for a single review and merge into dev. The original branch and commits remain available; no content was discarded.

@pgarciagon pgarciagon closed this Jul 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants