feat: support index.md as section file#460
Open
klocke-io wants to merge 1 commit into
Open
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
c490365 to
8818f1b
Compare
Adds openspec proposal to extend docforge's hardcoded _index.md section file detection to also recognize index.md, enabling VitePress-migrated repos to work without reverting renames.
089b037 to
4910a0d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
_index.mdsection file detection to also recognizeindex.mdindex.mdas section index — currently this bypasses thesectionFilespecial case inresolveManifestLinks, breaking overlay manifests silentlyplugin.go:22), confirming this was a known gapMotivation
When downstream repos migrate from Hugo to VitePress and rename
_index.md→index.md, docforge no longer auto-generates the section index from frontmatter. Instead it treats it as a normal file, resolves its source, and fetches real content — overwritingl section metadata.Proposal
Minimal approach: add an
isSectionFile(name string) boolhelper that matches both_index.mdandindex.md, update the 5 affected call sites. Full details in the proposal document.Test plan
openspec/changes/support-index-md-as-section-file/proposal.md