Skip to content

Improve readability and navigation of docs through updated info arch.#329

Open
johnnymatthews wants to merge 11 commits into
mainfrom
refactor/info-arch-restructure
Open

Improve readability and navigation of docs through updated info arch.#329
johnnymatthews wants to merge 11 commits into
mainfrom
refactor/info-arch-restructure

Conversation

@johnnymatthews

@johnnymatthews johnnymatthews commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

PREVIEW HERE

Closes #242

For testing:

  • Build site (zola build). Make sure there are no build errors.
  • Check that LLMs.txt and LLMs-full.txt are being generated. They can be found a /llms.txt and llms-full.txt respectivly.
  • Run through the site to check pages render properly.
  • Give the sidebar a good look. Are the pages in the order that you expect?

@johnnymatthews johnnymatthews changed the title Refactor/info arch restructure Improve readability and navigation of docs through updated info arch. Jul 21, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 21, 2026

Copy link
Copy Markdown

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: f366534
Status: ✅  Deploy successful!
Preview URL: https://596794a9.docs-czv.pages.dev
Branch Preview URL: https://refactor-info-arch-restructu.docs-czv.pages.dev

View logs

@johnnymatthews
johnnymatthews marked this pull request as ready for review July 23, 2026 10:40
Comment thread content/build/publish-and-earn/index.md Outdated
+++
draft = true
title = "Publish & earn"
description = "How to publish Views to the network and earn SHNZ from consumption."

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: We wont be incentivizing view creation by paying the view author.

Comment thread content/run/get-started/index.md Outdated
cp -r ~/.defra/keys /mnt/backup-drive/
```

### What types of data are indexed?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### What types of data are indexed?
### What type of data is indexed?


### How long does it take to sync?

Sync time depends entirely on the chosen start height. The further back the Generator client begins, the longer it will take to catch up to the current block height. The Generator client processes blocks approximately 2–4 seconds per block, which is faster than Ethereum's 12-second block time. This allows the Generator client to gradually close any sync gap after initial backfilling.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should consider rewriting this to discuss how syncing the generator is not a priority since the host only writes blocks as they are written. No need to discuss archive nodes atm. Data in data out, theres no way for a host to request 'synced' blocks atm


### What is the difference between a Host and a Generator?

Generator clients are the write side: they read raw blocks from an Ethereum execution node, sign the data, and gossip it over P2P. Host clients are the read side: they receive those signed primitives, verify them, run WebAssembly lens transforms to build Views, and serve the results to applications over GraphQL. A Generator client talks to a source-chain node; a Host client never does. See the [Run a Host](/run/run-a-host/) overview for more.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be good to add something about attestations being the record of which source wrote which blocks/document.


A public Generator client you can point at is planned; this page will link it once it's live.

### Can I connect my Host client to my own Generator client?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it is on the same machine then they need to change the common ports 9181, 9171, 8080

@@ -0,0 +1,28 @@
+++
title = "Views"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add section on materialized v non materialized

Comment thread content/understand/what-is-shinzo/index.md Outdated
Comment thread content/understand/what-is-shinzo/index.md Outdated
Comment thread content/build/publish-and-earn/index.md Outdated
Co-authored-by: dvncan <44993570+dvncan@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
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.

Info-arch restructure

2 participants