Skip to content

Changed index.md to README.md so that the docs home page also serves as the repo readme. - #8

Merged
davidstula merged 1 commit into
masterfrom
docs/readme-index
Sep 19, 2026
Merged

davidstula merged 1 commit into
masterfrom
docs/readme-index

Conversation

@davidstula

Copy link
Copy Markdown
Owner

No description provided.

@github-actions

Copy link
Copy Markdown

AI documentation review

README.md:1 — Deleting the repository-root README removes the documentation shown on the repository’s GitHub landing page; docs/README.md does not replace it there. Keep a root README, or replace it with a short README that links to the published documentation.

docs/README.md:1 — Renaming the MkDocs entry page from index.md to README.md can prevent the site from having a root index.html when MkDocs uses automatic navigation, so the published site may no longer open at /. Keep this file as docs/index.md, or add/update mkdocs.yml navigation so README.md is explicitly mapped to the site homepage.

@davidstula
davidstula merged commit 3b2c05d into master Sep 19, 2026
2 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.

1 participant