Skip to content

Add README to docs index if no other docs found#31

Merged
theory merged 1 commit intomainfrom
index-readme
Feb 8, 2024
Merged

Add README to docs index if no other docs found#31
theory merged 1 commit intomainfrom
index-readme

Conversation

@theory
Copy link
Copy Markdown
Member

@theory theory commented Feb 8, 2024

If a distribution has a README and no other docs recognized by Text::Markup, add the README to the index. Previously the indexer only added the README to the distribution docs. It still does, but now also the docs index, because otherwise a docs search won't turn up results for a distribution with no other docs.

Add a test to be sure it actually indexes a README when there are no other docs.

Fixes #12.

If a distribution has a README and no other docs recognized by
Text::Markup, add the README to the index. Previously the indexer only
added the README to the distribution docs. It still does, but now also
the docs index, because otherwise a docs search won't turn up results
for a distribution with no other docs.

Add a test to be sure it actually indexes a README when there are no
other docs.

Fixes #12.
@theory theory self-assigned this Feb 8, 2024
@theory theory merged commit 8fdbe90 into main Feb 8, 2024
@theory theory deleted the index-readme branch February 8, 2024 21: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.

Add README to documentation Index if no other docs

1 participant