Skip to content

Chore/update docs - #472

Closed
JasonVranek wants to merge 32 commits into
mainfrom
chore/update-docs
Closed

JasonVranek wants to merge 32 commits into
mainfrom
chore/update-docs

Conversation

@JasonVranek

Copy link
Copy Markdown
Collaborator

Modernize docs to match the latest v0.10.0-rc1 prerelease.

  • Prefer "Signer Service" and "PBS Service" over "module" - module is reserved for usage like "commit module".
  • New release process removed stable branch so Docs CI triggered from main
  • Allow signer-api.yml swagger page to be viewed local

@JasonVranek
JasonVranek requested a review from a team June 5, 2026 19:18
JasonVranek added a commit that referenced this pull request Oct 5, 2026
Brings over the docs/docs tree, sidebars.js and api/signer-api.yml from
d628b78 (PR #472 head) as a straight file replacement. The docs on main
have not changed since that PR's merge base, so this is a clean port.

New pages:
- get_started/mux-key-loaders.md
- get_started/running/k8s.md
- get_started/running/metrics-catalog.md
- developing/extending-pbs.md
- developing/commit-modules.md (replaces developing/commit-module.md)

Removed: developing/custom-modules.md (folded into commit-modules.md).

sidebars.js rides along because it is what wires the new pages in, and it
also adds developing/prop-commit-signing.md, which was an orphan on main.

Out of scope here (later PR): docs/versioned_docs, docs/versions.json,
the docusaurus.config.js versioning keys, docs/src/pages/index.js and
crates/common/src/config/module.rs.
JasonVranek added a commit that referenced this pull request Oct 5, 2026
main and PR #472 both touched this file, so it is merged by hand rather
than replaced. Kept from main: the [[relays]] get_header stream block,
the fuller Stader loader wording, and the fulu_fork_slot example. Taken
from the PR: the module -> service terminology rename, the "All fields
are required" note on the inline custom chain, and the #signer-service
docs anchor.

Also corrected against the v0.10.0 code while merging:

- [signer.tls_mode] claimed a default of "certificate" with self-signed
  auto-generation. default_tls_mode() returns Insecure, and the cert
  path is read with std::fs::read (crates/common/src/config/signer.rs),
  so the files must already exist.
- [signer.remote] is listed as a supported signer type but
  StartSignerConfig bails with "Remote signer configured" at startup.
  Marked NOT IMPLEMENTED and dropped from the supported list, matching
  configuration.md ("for now, one remote signer is supported: Dirk").
- [[signer.dirk.hosts]] used `accounts`; DirkHostConfig calls the field
  `wallets`.
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.

1 participant