Skip to content

copy README into index.md (docs homepage)#20

Merged
stuitje merged 1 commit into
mainfrom
ks/fix_docs
Feb 2, 2026
Merged

copy README into index.md (docs homepage)#20
stuitje merged 1 commit into
mainfrom
ks/fix_docs

Conversation

@stuitje

@stuitje stuitje commented Feb 1, 2026

Copy link
Copy Markdown
Contributor

Description

This PR copies the README contents into index.md, to fix the issue with the documentation page.

Validation of changes

Built the documentation locally using mkdocs serve.

Checklist

  • I have followed the contributing guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • My changes generate no new warnings or errors
  • I have checked that the tests still pass on my computer
  • I have updated the docs, as appropriate
  • I have added tests for these changes, as appropriate
  • I have checked that all dependencies have been updated, as required

Relevant people

@EmmaPostolec

@stuitje stuitje self-assigned this Feb 1, 2026
@stuitje stuitje requested a review from EmmaPostolec as a code owner February 1, 2026 13:21
@stuitje stuitje added bug Something isn't working documentation Improvements or additions to documentation labels Feb 1, 2026

@EmmaPostolec EmmaPostolec left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great thanks a lot for updating the doc @stuitje :) Looks good to me for merging !

@stuitje stuitje merged commit b24147c into main Feb 2, 2026
6 checks passed
nichollsh pushed a commit that referenced this pull request Feb 23, 2026
copy README into index.md (docs homepage)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants