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

Make doc structure consistent and up-to-date #879

Merged
merged 4 commits into from
Dec 16, 2023
Merged

Commits on Dec 13, 2023

  1. Make doc structure consistent and up-to-date

    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
    Julian-O committed Dec 13, 2023
    Configuration menu
    Copy the full SHA
    ee64c96 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    f42b252 View commit details
    Browse the repository at this point in the history

Commits on Dec 14, 2023

  1. Apply suggestions from code review

    Co-authored-by: Mirko Galimberti <me@mirkogalimberti.com>
    Julian-O and misl6 committed Dec 14, 2023
    Configuration menu
    Copy the full SHA
    ac63dac View commit details
    Browse the repository at this point in the history
  2. Restore sponsor et al links

    Julian-O committed Dec 14, 2023
    Configuration menu
    Copy the full SHA
    9e3c3c0 View commit details
    Browse the repository at this point in the history