Skip to content

Add Hugo Docsite - #1974

Open
Mofi Rahman (moficodes) wants to merge 1 commit into
agent-substrate:mainfrom
moficodes:main
Open

Add Hugo Docsite#1974
Mofi Rahman (moficodes) wants to merge 1 commit into
agent-substrate:mainfrom
moficodes:main

Conversation

@moficodes

@moficodes Mofi Rahman (moficodes) commented Sep 29, 2026

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/

@moficodes Mofi Rahman (moficodes) changed the title [WIP] Add Hugo Docsite Add Hugo Docsite Sep 29, 2026
@Raji14 Raji (Raji14) self-assigned this Sep 29, 2026
stshrive
Steven Shriver (stshrive) reviewed Sep 29, 2026
View reviewed changes
Comment thread .github/workflows/site.yaml
@mayawang Maya Wang (mayawang) added area/dev-infra kind/docs Improvements or additions to documentation labels Sep 29, 2026
@linsun

Lin Sun (linsun) commented Oct 2, 2026

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

Benjamin Elder (BenTheElder) commented Oct 7, 2026

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

Benjamin Elder (BenTheElder) commented Oct 7, 2026

Copy link
Copy Markdown
Collaborator

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

@BenTheElder

Benjamin Elder (BenTheElder) commented Oct 22, 2026

Copy link
Copy Markdown
Collaborator

one docs thing: #3105

destijl
Greg Castle (destijl) reviewed Oct 23, 2026
View reviewed changes

@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.

Comment thread site/layouts/_shortcodes/home-redesign.html Outdated
Comment thread site/layouts/_shortcodes/home-redesign.html Outdated
Comment thread site/layouts/_shortcodes/home-redesign.html Outdated
Comment thread site/layouts/_shortcodes/home-redesign.html Outdated
@moficodes

Mofi Rahman (moficodes) commented Oct 23, 2026

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.

brandonroyal
Brandon Royal (brandonroyal) suggested changes Oct 26, 2026
View reviewed changes
Comment thread site/layouts/_shortcodes/home-redesign.html Outdated
Comment thread site/layouts/_shortcodes/home-redesign.html Outdated
Comment thread site/layouts/_shortcodes/home-redesign.html Outdated
Comment thread site/layouts/_shortcodes/home.html
Comment thread site/layouts/_shortcodes/home.html Outdated
brandonroyal
Brandon Royal (brandonroyal) approved these changes Oct 27, 2026
View reviewed changes

@brandonroyal Brandon Royal (brandonroyal) 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.

Pending a few minor comments, otherwise LGTM

@BenTheElder Benjamin Elder (BenTheElder) removed the DO NOT MERGE This PR must not be merged yet. label Oct 27, 2026
@BenTheElder Benjamin Elder (BenTheElder) added this to the M3 milestone Oct 27, 2026
@zlammerts-svg
Zheng Lammerts (zlammerts-svg) removed their request for review October 27, 2026 19:12
@pmandewalkar

Parnika Mandewalkar (pmandewalkar) commented Oct 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

hi! just wanted to share some UI comments if this is getting released soon. as per the comments above, this is just regarding the home page:

  • we should show the whole demo command at the top and not truncate
  • the worker visual doesn't make it clear that the actor is resuming on the worker; it kind of makes it seem like we are suspending resuming workers?
  • light/dark does not function at the bottom of page. we can either remove or add functionality?
  • the search function should point out where the search query exists in the results. in the current state I have no idea how my search results relate to my query

@destijl

Greg Castle (destijl) commented Oct 27, 2026

Copy link
Copy Markdown
Collaborator

LGTM

@moficodes
site: add a Hugo and Docsy website
50e17d5 
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 <mofi@google.com>
@BenTheElder

Benjamin Elder (BenTheElder) commented Oct 28, 2026

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

Benjamin Elder (BenTheElder) commented Oct 28, 2026

Copy link
Copy Markdown
Collaborator

... and we have to patch in https://github.com/cncf/foundation/blob/main/policies-guidance/website-guidelines.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thockin Tim Hockin (thockin) Awaiting requested review from thockin
@BenTheElder Benjamin Elder (BenTheElder) Awaiting requested review from BenTheElder
3 more reviewers
@destijl Greg Castle (destijl) destijl left review comments
@stshrive Steven Shriver (stshrive) stshrive left review comments
@brandonroyal Brandon Royal (brandonroyal) brandonroyal approved these changes
Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

@BenTheElder Benjamin Elder (BenTheElder)

Labels

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

Projects

None yet

Milestone

M3

Development

Successfully merging this pull request may close these issues.

Publish comprehensive Substrate docsite before v1.0 release

10 participants

@moficodes @linsun @BenTheElder @pmandewalkar @destijl @brandonroyal @stshrive @Raji14 @thockin @mayawang