Skip to content

feat: add on-site documentation and fix navigation#1

Merged
corylanou merged 1 commit intomainfrom
feat/onsite-docs
Mar 15, 2026
Merged

feat: add on-site documentation and fix navigation#1
corylanou merged 1 commit intomainfrom
feat/onsite-docs

Conversation

@corylanou
Copy link
Copy Markdown
Member

Summary

  • Update all nav/hero/footer links to point to on-site docs pages instead of GitHub
  • Add docs landing page at /docs/ with links to all documentation sections
  • Add 10 documentation articles synced from the hype repo (installation, CLI reference, quickstart, etc.)
  • "Get Started" button now links to /getting-started/ instead of GitHub
  • Footer updated: Docs | Blog | GitHub | RSS

Nav structure

/          → home (hero + articles)
/docs/     → docs landing with links to all doc pages
/docs/installation/
/docs/cli-reference/
/docs/quick-reference/
/docs/quickstart/
/docs/html-export/
/docs/preview/
/docs/mermaid/
/docs/marked/
/docs/slides/
/docs/blog/
/getting-started/ → tutorial

Test plan

  • Verify all nav links point to on-site pages (except GitHub)
  • Verify /docs/ renders the docs landing page
  • Verify each doc page renders at its expected URL
  • Verify hype blog build succeeds with no warnings
  • Verify images render on the blog generator doc page

Move all documentation on-site instead of linking back to GitHub.
Update nav, hero, and footer links to point to local doc pages.
Add docs landing page and 10 synced documentation articles.
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 052d0fe863

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


## Full Documentation

For complete documentation including theme customization, template overrides, and advanced features, see [docs/blog/README.md](README.md).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Point Full Documentation link to an existing page

The Full Documentation link targets README.md, but there is no content/docs-blog/README.md (or corresponding routed page), so users on /docs/blog/ will hit a 404 when they click it. Since this section is presented as the next step for advanced usage, it should link to a valid on-site URL (or a concrete GitHub URL) instead of a missing relative file.

Useful? React with 👍 / 👎.


### AI Assistants

For detailed skill documentation, see [`.agent/skills/hype/`](.agent/skills/hype/).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove broken .agent docs link from quick reference

This link points to .agent/skills/hype/, but that path is not present in this repository and will not exist in the generated site, so it resolves to a dead link for readers of /docs/quick-reference/. Replacing it with a real public docs location avoids sending users to an unreachable internal path.

Useful? React with 👍 / 👎.

@corylanou corylanou merged commit 58ff730 into main Mar 15, 2026
1 check passed
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