Skip to content

docs: GETTING_STARTED guide + landing page & SEO integration - #167

Merged
jkyberneees merged 1 commit into
mainfrom
feat/getting-started-guide
Aug 31, 2026
Merged

docs: GETTING_STARTED guide + landing page & SEO integration#167
jkyberneees merged 1 commit into
mainfrom
feat/getting-started-guide

Conversation

@jkyberneees

Copy link
Copy Markdown
Contributor

Summary

New onboarding documentation and its landing-page/SEO integration:

  • GETTING_STARTED.md (repo root): odek install (go install / release one-liner / odek upgrade), odek init --global + ~/.odek/secrets.env, GLM 5.3 Flash (z.ai GLM Coding Plan) configuration, sandbox note (default-on; ODEK_NO_SANDBOX=1), first run / REPL / serve, optional bodek TUI install + flags, How to upgrade (odek upgrade, bodek upgrade), GLM quick-reference, max_concurrency 429 tuning, troubleshooting
  • README.md: link to the guide after build requirements
  • docs/index.html (landing page): Get Started nav link, install-section walkthrough callout, first docs-grid card, final-CTA button; SEO meta description tightened to 150 chars with GLM 5.3 Flash (z.ai) terms; keywords extended
  • docs/llms.txt: Getting Started first under "Start here" (raw.githubusercontent URL for agent fetches)
  • docs/sitemap.xml: homepage lastmod bump

Verification

  • Every command/claim fact-checked against code (KnownProfiles, upgrade.go, init templates, serve defaults, danger/sandbox behavior) and z.ai's own docs (Coding Plan OpenAI endpoint)
  • 2-judge review panel applied (technical accuracy + SEO/UX); both judge blockers fixed: odek release one-liner now uses direct binary download (assets are raw binaries — darwin/linux only, no archives), "archives" wording corrected
  • One-liner empirically validated against latest release assets

/docs

- New GETTING_STARTED.md: odek install, GLM 5.3 Flash (z.ai Coding Plan)
  setup, secrets.env, sandbox, first run, optional bodek TUI, upgrade
  commands (odek upgrade / bodek upgrade), troubleshooting
- README: link the guide after build requirements
- docs/index.html: 'Get Started' nav link, install-section walkthrough
  callout, first docs-grid card, final-CTA button; SEO meta descriptions
  (150 chars), keywords extended with GLM 5.3 Flash / z.ai / bodek
- docs/llms.txt: Getting Started entry first under 'Start here' (raw URL)
- docs/sitemap.xml: homepage lastmod bump

Judge-verified: 2-judge review panel (technical accuracy + SEO/UX);
odek one-liner install command empirically validated against release
assets (raw binaries, darwin/linux only — no Windows archives).
@jkyberneees
jkyberneees merged commit ec6e696 into main Aug 31, 2026
10 checks passed
@jkyberneees
jkyberneees deleted the feat/getting-started-guide branch August 31, 2026 14:31
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