Skip to content

fix(website): uglyURLs on main, update documentation - #4871

Merged
asim merged 7 commits into
micro:masterfrom
alex-dna-tech:master
Aug 4, 2026
Merged

asim merged 7 commits into
micro:masterfrom
alex-dna-tech:master

Conversation

@alex-dna-tech

@alex-dna-tech alex-dna-tech commented Jul 31, 2026 •

Copy link
Copy Markdown
Contributor

Description

Completes the website's migration from the Jekyll-era docs layout to the Hugo content/en tree. The docs site previously shipped pages from two parallel trees (docs/.md plus docs/overview//index.md and docs/index.md symlinks), which produced duplicate URLs and broken links. This change collapses everything to a single canonical tree, switches cross-references from .html to .md/index.md targets, drops the old vanity-redirect machinery, and updates the docs wayfinding tests to the new layout.
What changed

  • Drop Jekyll vanity redirects (37c5da9) — remove scripts/add-aliases.py, scripts/data/vanity.yaml, and the stale about page; fix the remaining .html links on the main page for uglyURLs mode.
  • Fix contributing paths (08e2603) — CONTRIBUTING.md and the contributing docs now point at the real post-migration file locations instead of Jekyll-era paths.
  • Dedupe duplicate pages (db247da) — every doc title resolves to one canonical page. Keeps directory-index pages with bundled images, drops draft copies, removes the docs/index.md/docs/examples/index.md symlinks, and standardizes on _index.md for section landings.
  • Merge the duplicate tree (2250d78) — moves pages out of docs/overview/ into the canonical docs locations, deletes the now-empty overview tree, and consolidates the ADRs under docs/project/architecture/.
  • Fix links + tests (2dcb452) — replaces all Jekyll-era .html cross-links with .md/index.md targets across the docs, fixes relative paths for pages moved into Hugo bundles, restores the ADR files, and updates the internal/harness/zero-to-hero-ci/docs_test.go wayfinding tests to the content/en/docs layout.
  • Realign CLI docs test (bf03da1) — cmd/micro/first_agent_walkthrough_test.go now expects the new .md guide links in the docs and translates .md → .html when comparing against the first-agent CLI output (which still emits .html breadcrumbs), keeping README/website/CLI breadcrumbs aligned.

Net effect

112 files changed across upstream/master..origin/master: +498 / −5022, almost entirely website docs, scripts, and the two docs-wayfinding test suites.

Testing

  • go build ./...
  • go test ./cmd/micro/... (first-agent walkthrough contract)
  • go test ./internal/harness/zero-to-hero-ci/... (docs wayfinding, guide chains, canonical trail)
  • make docs-wayfinding

@alex-dna-tech
alex-dna-tech marked this pull request as draft July 31, 2026 06:12
@alex-dna-tech alex-dna-tech changed the title fix(website): more uglyURLs on main page fix(website): uglyURLs on main, update documentation Jul 31, 2026
@alex-dna-tech

Copy link
Copy Markdown
Contributor Author

Duplicate frontmatter titles in internal/website/content/en/

Duplicate Title File 1 File 2
Agent Guardrails blog/news/agent-guardrails.md docs/guides/agent-guardrails.md
AI Integration docs/ai-integration.md docs/overview/ai-integration/index.md
Architecture docs/architecture.md docs/overview/architecture/index.md
Architecture Decision Records docs/architecture/index.md docs/project/architecture/_index.md
Broker docs/broker.md docs/interfaces/broker/index.md
Configuration docs/config.md docs/overview/config/index.md
Contributing docs/contributing.md docs/guides/contributing.md, docs/project/contributing.md
Documentation docs/_index.md docs/index.md
Examples docs/examples/_index.md docs/examples/index.md
Getting Started docs/getting-started.md docs/overview/getting-started/index.md
Hello Service docs/examples/hello-service.md docs/examples/learn-by-examples/hello-service.md
Observability docs/observability.md docs/overview/observability/index.md
Performance Considerations docs/overview/performance.md docs/performance.md
Plugins docs/interfaces/plugins.md docs/plugins.md
Pub/Sub with NATS Broker docs/examples/learn-by-examples/pubsub-nats.md docs/examples/pubsub-nats.md
Quick Start docs/guides/quickstart.md docs/quickstart.md
Registry docs/interfaces/registry/index.md docs/registry.md
Roadmap docs/project/roadmap.md docs/roadmap.md
Service Discovery with Consul docs/examples/learn-by-examples/registry-consul.md docs/examples/registry-consul.md
Store docs/interfaces/store.md docs/store.md
Summary: Reflection Removal Evaluation docs/overview/REFLECTION-EVALUATION-SUMMARY.md docs/REFLECTION-EVALUATION-SUMMARY.md
TLS Security Update - Important Information docs/overview/TLS_SECURITY_UPDATE.md docs/TLS_SECURITY_UPDATE.md
Transport docs/interfaces/transport/index.md docs/transport.md

All paths are relative to internal/website/content/en/. 23 duplicated titles across 47 files (Contributing has 3 copies).

Remove duplicate page titles in internal/website/content/en so every
title resolves to a single canonical page. Precedence: directory index
pages with bundled images, then the most complete content; draft copies
were dropped.

Removed duplicates (kept page in parentheses):
- docs/overview/*/index.md (dir index + image) vs docs/*.md for
  ai-integration, architecture, config, getting-started, observability
- docs/interfaces/{broker,registry,transport}/index.md (dir index +
  image) vs docs/{broker,registry,transport}.md
- docs/interfaces/{plugins,store}.md vs docs/{plugins,store}.md
- docs/contributing.md and docs/guides/contributing.md vs
  docs/project/contributing.md
- docs/guides/quickstart.md vs docs/quickstart.md
- docs/overview/performance.md vs docs/performance.md
- docs/project/{roadmap,roadmap-2026}.md vs docs/roadmap.md
- docs/architecture/{index,adr-*}.md (already mirrored and kept in
  docs/project/architecture/, whose index now links the available ADRs)
- docs/model.md vs docs/model/index.md
- blog/news/agent-guardrails.md vs docs/guides/agent-guardrails.md
- docs/examples/learn-by-examples/* (near-identical copies) vs
  docs/examples/*
- docs/overview/{REFLECTION-EVALUATION-SUMMARY,TLS_SECURITY_UPDATE}.md
  (draft copies)
- docs/index.md and docs/examples/index.md symlinks vs their _index.md

Frontmatter tidy: add missing descriptions (store, atlas-cloud, model),
drop weight/draft overrides, consolidate the Architecture Decision
Records index, and remove dead CSS overrides from _styles_project.scss.

Hugo conventions: _index.md is the branch/section bundle for a
directory - it is the landing page for a doc section that lists its
children. index.md is a leaf bundle - a standalone page at the exact
directory URL whose directory bundles its own resources (images, etc.).
The docs site standardizes on _index.md for section landing pages, so
the redundant index.md symlinks were removed and the duplicate
Architecture directory was merged into the project/architecture section.
…ration

Replace Jekyll-era .html links with .md/index.md targets, fix relative
paths for pages moved into Hugo bundles, restore the ADR files dropped by
the duplicate-merge refactor, and update zero-to-hero-ci docs tests to the
content/en/docs layout.
@alex-dna-tech
alex-dna-tech marked this pull request as ready for review August 3, 2026 12:24
@alex-dna-tech

alex-dna-tech commented Aug 3, 2026 •

Copy link
Copy Markdown
Contributor Author

What It Does: Hugo uses index.md for single pages containing bundled resources, and _index.md for parent section pages that list multiple subpages.

Why People Use It: It organizes content clearly, separating standalone pages with media resources from directory-style parent pages that aggregate and list other child content.

HOW TO USE IT

Most Common Syntax: Create an index.md for a single content bundle or a _index.md for a section listing page within your content directory.

COMMON USE CASES

For Creating a Standalone Page with Media Resources: content/blog-post/index.md
For Creating a Parent Section Listing Subpages: content/blog/_index.md
For Processing and Resizing Page-Bundled Images: {{ (.Resources.Get "image.jpg").Resize "600x webp" }}

MOST IMPORTANT AND USED OPTIONS AND FEATURES

  • index.md: Defines a leaf bundle (single page) which allows you to store associated assets like images and documents directly alongside the markdown file for easy processing.
  • _index.md: Defines a branch bundle (parent page) which enables you to add front matter, content, and templates for listing and organizing multiple subpages.
  • Page Resources: Allows index.md to manipulate bundled assets, such as converting images to WebP format and resizing them dynamically within your templates.

@alex-dna-tech

Copy link
Copy Markdown
Contributor Author

@asim ready to review

@asim
asim merged commit 7159377 into micro:master Aug 4, 2026
8 checks 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.

2 participants