Skip to content

Convert README AND CONTRIBUTING from rst to md and update the contents.#277

Merged
mielvds merged 9 commits into
docs/mkdocs-materialfrom
update-readme
Jun 10, 2026
Merged

Convert README AND CONTRIBUTING from rst to md and update the contents.#277
mielvds merged 9 commits into
docs/mkdocs-materialfrom
update-readme

Conversation

@mielvds

@mielvds mielvds commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Updates the README to the latest state of the repo and converts it to markdown (in line with other docs)

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown

@anatoly-scherbakov anatoly-scherbakov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

There are a few Markdown/RST conversion issues that affect rendered links. I left commit-able suggestions for the ones that are on changed diff lines.

One related issue is outside this PR diff: CHANGELOG.md still has an older README.rst#conformance link, which will be broken after this README rename.

Comment thread CONTRIBUTING.rst Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
mielvds and others added 5 commits June 10, 2026 13:41
Co-authored-by: Anatoly Scherbakov <altaisoft@gmail.com>
Co-authored-by: Anatoly Scherbakov <altaisoft@gmail.com>
@mielvds mielvds changed the title Convert README from rst to md and update the contents. Convert README AND CONTRIBUTING from rst to md and update the contents. Jun 10, 2026
@mielvds

mielvds commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator Author

@anatoly-scherbakov thanks for patching those! I converted CONTRIBUTING as well so everything is in markdown now and changed the link in CHANGELOG. Feel free to have another quick look

@mielvds mielvds merged commit 1d7079c into docs/mkdocs-material Jun 10, 2026
20 checks passed
@mielvds mielvds deleted the update-readme branch June 10, 2026 13:22
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.

2 participants