Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README, add MarkDown changelog, and mention documentation in the PyPI links #249

Merged
merged 3 commits into from
Feb 21, 2024

Conversation

felixfontein
Copy link
Collaborator

No description provided.

@felixfontein felixfontein changed the title Improve README and mention documentation in the PyPI links Improve README, add MarkDown changelog, and mention documentation in the PyPI links Feb 14, 2024
README.md Outdated Show resolved Hide resolved
Co-authored-by: Maxwell G <maxwell@gtmx.me>
"Source code" = "https://github.com/ansible-community/antsibull-docs"
"Code of Conduct" = "https://docs.ansible.com/ansible/latest/community/code_of_conduct.html"
"Bug tracker" = "https://github.com/ansible-community/antsibull-docs/issues"
"Changelog" = "https://github.com/ansible-community/antsibull-docs/tree/main/CHANGELOG.md"
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM, but I'd consider including the Changelog in the documentation site and linking to that instead. You can symlink docs/changelog.md -> ../CHANGELOG.md.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tried that, but it looks like shit, since mkdocs only supports a specific dialect of MarkDown and not CommonMark. IIRC it shows \ everywhere since the MarkDown dialect it supports doesn't allow to use it for escaping.

(Ref: mkdocs/mkdocs#1835)

Copy link
Collaborator

@gotmax23 gotmax23 Feb 21, 2024

Choose a reason for hiding this comment

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

I opened ansible-community/antsibull-changelog#153. There is still the double table of contents (one from mkdocs-material and another from antsibull-changelog), but at least, it's properly formatted.

Copy link
Collaborator

Choose a reason for hiding this comment

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

s/changelog/table of contents/

@felixfontein felixfontein merged commit b0ebda2 into ansible-community:main Feb 21, 2024
11 of 12 checks passed
@felixfontein felixfontein deleted the docs branch February 21, 2024 06:17
@felixfontein
Copy link
Collaborator Author

@gotmax23 thanks for reviewing this!

@gotmax23
Copy link
Collaborator

Thanks for working on it!

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