Make doc structure consistent and up-to-date #879
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
misl6
reviewed
Dec 12, 2023
|
We have a conflict + the PR is in draft (I guess by mistake). |
This is part of an effort to make the Kivy sibling projects' documentation structure consistent and up-to-date. Unrelated fixes: * Mild copy-edit of README * Mention it only works on macOS CHECKLIST * CONTRIBUTING.md [x] If repo takes user contributions, is present [x] In root dir (not .github dir) [x] Refers to kivy/kivy Contribution Guidelines. * LICENSE [x] If repo takes user contributions, is present. [x] Acknowledges the range of years to 2023. [x] Acknowledges Kivy Team and other contributors [x] Mentions it is an MIT License. * CODE_OF_CONDUCT.md [x] If repo takes user contributions or hosts discussions, is present. [x] Refers to kivy/kivy CODE_OF_CONDUCT.md * CONTACT.md [x] Refers to kivy/kivy CONTACT.md * FAQ.md [NA] If repo is big enough for RST documentation, is present. ** Added anyway because it was bloating the README ** * README: [x] Is a Markdown file. [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] If CONTRIBUTING exists, mentions it. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [NA] Uses Python syntax colouring for embedded Python code. [x] Uses badges to display current status. * RST documentation, if present [NA] Describes the project. [NA] Describes its place in the Kivy sibling projects. [NA] Mentions LICENSE. [NA] Mentions CONTRIBUTING [NA] Mentions CODE_OF_CONDUCT [NA] Mentions FAQ * WORKFLOWS [x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [x] NO_RESPONSE uses latest script versions. [x] SUPPORT.yml is present if the repo has a `support` tag. [x] SUPPORT.yml refers to kivy/kivy CONTACT.md * setup.py/cfg, if present and on PyPI [x] Supplies description to PyPI [x] Supplies Python versions to PyPI [NA] Supplies Documentation, if any, to PyPI [x] Supplies GitHub link to PyPI
|
@misl6: So sorry. I believe I have those fixed now. |
Co-authored-by: Mirko Galimberti <[email protected]>
|
@misl6 Thanks again for your diligence. Updated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Kivy-IOS
This is part of an effort to make the Kivy sibling projects' documentation
structure consistent and up-to-date.
Unrelated fixes:
CHECKLIST
CONTRIBUTING.md
[x] If repo takes user contributions, is present
[x] In root dir (not .github dir)
[x] Refers to kivy/kivy Contribution Guidelines.
LICENSE
[x] If repo takes user contributions, is present.
[x] Acknowledges the range of years to 2023.
[x] Acknowledges Kivy Team and other contributors
[x] Mentions it is an MIT License.
CODE_OF_CONDUCT.md
[x] If repo takes user contributions or hosts discussions, is present.
[x] Refers to kivy/kivy CODE_OF_CONDUCT.md
CONTACT.md
[x] Refers to kivy/kivy CONTACT.md
FAQ.md
[NA] If repo is big enough for RST documentation, is present.
** Added anyway because it was bloating the README **
README:
[x] Is a Markdown file.
[x] Describes the project.
[x] Describes its place in the Kivy sibling projects.
[x] If CONTRIBUTING exists, mentions it.
[x] If LICENSE exists, mentions it.
[x] If CODE_OF_CONDUCT exists, mentions it.
[x] Mentions kivy/kivy CONTACT.md
[NA] Uses Python syntax colouring for embedded Python code.
[x] Uses badges to display current status.
RST documentation, if present
[NA] Describes the project.
[NA] Describes its place in the Kivy sibling projects.
[NA] Mentions LICENSE.
[NA] Mentions CONTRIBUTING
[NA] Mentions CODE_OF_CONDUCT
[NA] Mentions FAQ
WORKFLOWS
[x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag.
[x] NO_RESPONSE uses latest script versions.
[x] SUPPORT.yml is present if the repo has a
supporttag.[x] SUPPORT.yml refers to kivy/kivy CONTACT.md
setup.py/cfg, if present and on PyPI
[x] Supplies description to PyPI
[x] Supplies Python versions to PyPI
[NA] Supplies Documentation, if any, to PyPI
[x] Supplies GitHub link to PyPI