Skip to content

Add Hugo Docsite - #1974

Merged
Tim Hockin (thockin) merged 1 commit into
agent-substrate:mainfrom
moficodes:main
Oct 29, 2026
Merged

Tim Hockin (thockin) merged 1 commit into
agent-substrate:mainfrom
moficodes:main

Conversation

@moficodes

Copy link
Copy Markdown
Collaborator

Fixes #1863

It's a good idea to open an issue first for discussion.

  • Tests pass
  • Appropriate changes to documentation are included in the PR

Github Pages URL from the fork: https://moficodes.github.io/substrate/

Comment thread .github/workflows/site.yaml Resolved
@linsun

Copy link
Copy Markdown

The site looks great, great work!

I would love to have a section for blogs and events if we could, highlighting upcoming events such as substrate day and kubecon NA. :)

@BenTheElder

Copy link
Copy Markdown
Collaborator

I would love to have a section for blogs and events if we could, highlighting upcoming events such as substrate day and kubecon NA. :)

Let's consider that in a follow-up.

Blogs will be a bit of a fun issue, because then we have to sort out policy about what sort of promotion upstream permits. That has been a bit of a pain point in Kubernetes. cc Tim Hockin (@thockin)

I think we can put up a sort of banner for "official" events like substrate day, but it might be a bit late for that in the immediate future anyhow.

@BenTheElder Benjamin Elder (BenTheElder) added the DO NOT MERGE This PR must not be merged yet. label Oct 7, 2026
@BenTheElder

Copy link
Copy Markdown
Collaborator

We want sign-off from Brandon Royal (@brandonroyal) before shipping this. Thanks.

@BenTheElder

Copy link
Copy Markdown
Collaborator

one docs thing: #3105

@destijl Greg Castle (destijl) left a comment

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.

This rocks, great job. The way I reviewed this was just looking at the front page. Is that right? I'm assuming the rest of the content is derived from the markdown documentation and if we want to fix it we should update the markdown source? Let me know if I'm off-base here.

@moficodes

Copy link
Copy Markdown
Collaborator Author

This rocks, great job. The way I reviewed this was just looking at the front page. Is that right? I'm assuming the rest of the content is derived from the markdown documentation and if we want to fix it we should update the markdown source? Let me know if I'm off-base here.

In this new build, site/ literally contains no markdown. Everything is driven by the existing docs. So down the line we can just update the respective doc where they are and the site will hoover it all up.

So yes, just the home page is owned by the site.

Comment thread site/layouts/_shortcodes/home.html Resolved
Comment thread site/layouts/_shortcodes/home.html Resolved
@BenTheElder

Copy link
Copy Markdown
Collaborator

Made a few suggestions offline, I like where the preview is heading, thank you!!

Needs a rebase, we will revisit tomorrow.

@BenTheElder Benjamin Elder (BenTheElder) added the prio/P0 Highest priority / required for next milestone label Oct 28, 2026
@BenTheElder

Copy link
Copy Markdown
Collaborator

@HavenXia Haven Xia (HavenXia) mentioned this pull request Oct 29, 2026
2 tasks done
Add the Agent Substrate documentation website under site/ (https://ate.dev/),
built with Hugo and the Docsy theme:

- Reorganize user-facing docs under docs/{get-started,concepts,guides,reference,security,project}/
  and move CONTRIBUTING.md, cmd/kubectl-ate/README.md, and benchmarking/README.md into docs/
  with pointer files at their original paths.
- Keep tutorial READMEs alongside their code in demos/*/README.md and mark contributor-only
  root docs with 'docsite: false' in YAML front matter.
- Generate site/content/ on the fly via tools/site-content before serving or building the site,
  with zero checked-in Markdown stubs under site/content/.
- Add homepage with zero-trust security principles, capability cards, interactive quickstart,
  and demo video, plus collapsible three-column doc layout, glossary hover cards, doc status
  banners, New release badges (tools/site-release-data), Copy as Markdown, and /llms.txt.

Signed-off-by: Mofi Rahman <[email protected]>
@moficodes

Copy link
Copy Markdown
Collaborator Author

@thockin
Tim Hockin (thockin) added this pull request to the merge queue Oct 29, 2026
Merged via the queue into agent-substrate:main with commit c757792 Oct 29, 2026
7 checks passed
Haven Xia (HavenXia) added a commit to HavenXia/substrate that referenced this pull request Oct 29, 2026
An SVG with CSS animation, which GitHub plays inline: 250 agents,
the atenet router, 8 warm worker pods. Copy follows the docsite
hero (agent-substrate#1974) and the greens come from the logo. The latency figure
is left out until the number is settled. prefers-reduced-motion
shows the static frame.

Signed-off-by: Haven Xia <[email protected]>
Haven Xia (HavenXia) added a commit to HavenXia/substrate that referenced this pull request Oct 29, 2026
An SVG with CSS animation, which GitHub plays inline: 250 agents,
the atenet router, 8 warm worker pods. Copy follows the docsite
hero (agent-substrate#1974) and the greens come from the logo. The latency figure
is left out until the number is settled. prefers-reduced-motion
shows the static frame.

Signed-off-by: Haven Xia <[email protected]>
Haven Xia (HavenXia) added a commit to HavenXia/substrate that referenced this pull request Oct 29, 2026
An SVG with CSS animation, which GitHub plays inline: 250 agents,
the atenet router, 8 warm worker pods with several sandboxes each.
Copy follows the docsite hero (agent-substrate#1974) and the greens come from the
logo. The latency figure is left out until the number is settled.
prefers-reduced-motion shows the static frame.

Signed-off-by: Haven Xia <[email protected]>
Haven Xia (HavenXia) added a commit to HavenXia/substrate that referenced this pull request Oct 29, 2026
An SVG with CSS animation, which GitHub plays inline: 250 agents,
the atenet router, 8 warm worker pods with several sandboxes each.
Copy follows the docsite hero (agent-substrate#1974) and the greens come from the
logo. The latency figure is left out until the number is settled.
prefers-reduced-motion shows the static frame.

The badge row adds release, CI, govulncheck, stars and Trendshift.
Go Report Card is retired, so it is left out.

Signed-off-by: Haven Xia <[email protected]>
Haven Xia (HavenXia) added a commit to HavenXia/substrate that referenced this pull request Oct 29, 2026
An SVG with CSS animation, which GitHub plays inline: 250 agents,
the atenet router, 8 warm worker pods with several sandboxes each.
Copy follows the docsite hero (agent-substrate#1974) and the greens come from the
logo. The latency figure is left out until the number is settled.
prefers-reduced-motion shows the static frame.

The badge row adds release, CI, govulncheck, stars and Trendshift.
Go Report Card is retired, so it is left out.

Signed-off-by: Haven Xia <[email protected]>
Zoe Zhao (zoez7) pushed a commit to zoez7/substrate that referenced this pull request Nov 2, 2026
Supersedes agent-substrate#3396 by @stshrive, rebased onto current `main`. The commit
keeps his authorship and sign-off.

The GKE provisioning and teardown tooling now lives in
https://github.com/ai-on-gke/substrate-gke under tools/setup-gcp, so
core no longer carries a copy. Docs and comments that pointed at the
removed files now point at substrate-gke. go mod tidy drops the GCP
client modules only setup-gcp used, and vendor/ and _LICENSES/ are
regenerated to match.

Covers agent-substrate#3390, except that hack/teardown.sh is removed here as well;
substrate-gke's tools/setup-gcp/teardown.sh replaces it.

Part of agent-substrate#2304

### Rebase notes
Conflicts were mostly from the Hugo docsite move (agent-substrate#1974):
- `tools/setup-gcp/cloud-sql.md`: deleted, as in the original PR.
- `docs/guides/operator-install.md`, `docs/guides/postgres.md`: the
original edits, re-applied at the new paths.
- `docs/guides/observability.md`: kept main's version, since agent-substrate#1974
already removed the Dashboards section the original PR edited.
- `cmd/kubectl-ate/README.md`: kept main's stub that points to
`docs/reference/kubectl-ate.md`. That page no longer has the setup-gcp
line, so the edit had nowhere to go.

---------

Signed-off-by: Steven Shriver <[email protected]>
Signed-off-by: Grant McCloskey <[email protected]>
Co-authored-by: Steven Shriver <[email protected]>
Grant McCloskey (MushuEE) added a commit to MushuEE/substrate that referenced this pull request Nov 2, 2026
Supersedes agent-substrate#3396 by @stshrive, rebased onto current `main`. The commit
keeps his authorship and sign-off.

The GKE provisioning and teardown tooling now lives in
https://github.com/ai-on-gke/substrate-gke under tools/setup-gcp, so
core no longer carries a copy. Docs and comments that pointed at the
removed files now point at substrate-gke. go mod tidy drops the GCP
client modules only setup-gcp used, and vendor/ and _LICENSES/ are
regenerated to match.

Covers agent-substrate#3390, except that hack/teardown.sh is removed here as well;
substrate-gke's tools/setup-gcp/teardown.sh replaces it.

Part of agent-substrate#2304

### Rebase notes
Conflicts were mostly from the Hugo docsite move (agent-substrate#1974):
- `tools/setup-gcp/cloud-sql.md`: deleted, as in the original PR.
- `docs/guides/operator-install.md`, `docs/guides/postgres.md`: the
original edits, re-applied at the new paths.
- `docs/guides/observability.md`: kept main's version, since agent-substrate#1974
already removed the Dashboards section the original PR edited.
- `cmd/kubectl-ate/README.md`: kept main's stub that points to
`docs/reference/kubectl-ate.md`. That page no longer has the setup-gcp
line, so the edit had nowhere to go.

---------

Signed-off-by: Steven Shriver <[email protected]>
Signed-off-by: Grant McCloskey <[email protected]>
Co-authored-by: Steven Shriver <[email protected]>
(cherry picked from commit b66e16a)
Dmitry Berkovich (dberkov) pushed a commit that referenced this pull request Nov 3, 2026
Supersedes #3396 by @stshrive, rebased onto current `main`. The commit
keeps his authorship and sign-off.

The GKE provisioning and teardown tooling now lives in
https://github.com/ai-on-gke/substrate-gke under tools/setup-gcp, so
core no longer carries a copy. Docs and comments that pointed at the
removed files now point at substrate-gke. go mod tidy drops the GCP
client modules only setup-gcp used, and vendor/ and _LICENSES/ are
regenerated to match.

Covers #3390, except that hack/teardown.sh is removed here as well;
substrate-gke's tools/setup-gcp/teardown.sh replaces it.

Part of #2304

### Rebase notes
Conflicts were mostly from the Hugo docsite move (#1974):
- `tools/setup-gcp/cloud-sql.md`: deleted, as in the original PR.
- `docs/guides/operator-install.md`, `docs/guides/postgres.md`: the
original edits, re-applied at the new paths.
- `docs/guides/observability.md`: kept main's version, since #1974
already removed the Dashboards section the original PR edited.
- `cmd/kubectl-ate/README.md`: kept main's stub that points to
`docs/reference/kubectl-ate.md`. That page no longer has the setup-gcp
line, so the edit had nowhere to go.

---------

Signed-off-by: Steven Shriver <[email protected]>
Signed-off-by: Grant McCloskey <[email protected]>
Co-authored-by: Steven Shriver <[email protected]>
(cherry picked from commit b66e16a)
Signed-off-by: Eitan Yarmush <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/dev-infra kind/docs Improvements or additions to documentation milestone-ack prio/P0 Highest priority / required for next milestone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish comprehensive Substrate docsite before v1.0 release

10 participants