Skip to content

Proposal: explore section-level sitemap output #55

@KimHyeongRae0

Description

@KimHyeongRae0

Proposal

Explore optional section-level sitemap output for larger sites.

Why

The current sitemap generator emits a single URL-level sitemap. That is a good default, but larger documentation or content-heavy sites may benefit from an additional section-level view that groups related pages by directory or content area. This can make generated discovery files easier for crawlers and downstream tools to reason about.

Possible Output

Examples:

  • sitemap.xml: existing URL-level sitemap, unchanged.
  • section-sitemap.json: section summaries derived from URL paths and page metadata.
  • Optional references from ai-index.json or report output to the section groups.

Example shape:

{
  "sections": [
    {
      "path": "/docs",
      "title": "Docs",
      "pages": ["/docs/getting-started", "/docs/configuration"]
    }
  ]
}

Questions

  • Should this be enabled by default or behind a new generator flag?
  • Should sections be inferred from URL paths, configured manually, or both?
  • Should the output be XML, JSON, or only added to existing AI-facing JSON assets?

Non-Goals

  • No changes to the existing sitemap.xml default behavior.
  • No search engine ranking claims.
  • No required page metadata changes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions