Skip to content

SUMAMRY.md -> index.md for OKF compatibility? #49

Closed

Description

@yuval-block

@bc1cindy any particular reason why SUMMARY.md is named the way it is?

if it's arbitrary then i think we should rename to index.md and add OKF preambles, as well as something to strip those out of the mdbook rendering, i did that in my ephemeral-ecmh repo so we can just cargo cult the pattern here

the rationale is that the mdbook chapter listing and okf index serve essentially the same purpose, the former for humans and the latter for agents, unifying them ensures they don't go out of sync. we may choose to deliberately split them at some point if index.md needs to contain a superset but i don't anticipate that

Activity

  1. bc1cindy commented on Oct 10, 2026

    @bc1cindy
    Member

    no reason at all, it's just the mdbook default

    awesome idea! want me to take it?

  2. bc1cindy commented on Oct 10, 2026

    @bc1cindy
    Member

    mdbook actually requires the name SUMMARY.md, it's not just a default

    so in #50 index.md is the source and SUMMARY.md gets generated from it at build time

  3. self-assigned this
    on Oct 10, 2026
  4. added 5 commits that reference this issue on Oct 15, 2026
    0a6966d
    db30824
    e0220ff
    2a10cc5
    80996f5
  5. added a commit that references this issue on Oct 19, 2026
    d20289e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions