Skip to content

updates to requirements.txt and README.rst #154

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

joshuaboys
Copy link

@joshuaboys joshuaboys commented Jun 13, 2025

This pull request updates the README.rst file to provide a more comprehensive and engaging introduction to the Diátaxis Documentation Framework. The changes include a detailed explanation of the framework, its benefits, and resources for getting started, along with information about contributing and community support.

The pull request also updates the requirements.txt file to allow for flexible versioning and security updates of certifi, colorama, requests, and urllib3.

Updates to the README.rst file:

Framework Overview:

  • Replaced the previous brief description with a detailed explanation of the Diátaxis Documentation Framework, including its four content types: Tutorials, How-To Guides, Reference, and Explanation.

Benefits of the Framework:

  • Highlighted key advantages such as improved clarity, user-centered design, ease of application, and real-world usage by organisations.

Resources for Getting Started:

  • Added links to the official site, a quick primer, and the Diátaxis Compass for reviewing documentation.

Repository and Contribution Information:

  • Included details about the repository contents, contribution guidelines, and links for submitting pull requests or starting discussions.

Community and Support:

  • Provided information on connecting with other users via the Write the Docs Slack and GitHub Discussions.

Updates to the requirements.txt file:

Updates:

  • Updated Colorama to version 0.4.5 to address a compatibility issue with Sphinx on Windows systems
  • Included => on certifi, colorama, requests, and urllib3 to allow for flexible versioning and security updates

…y updates of certifi, colorama, requests, and urllib3 abd updated colorama version to fix windows compatibility issue with sphinx
…, outlining its structure, benefits, and resources for getting started. Enhanced clarity and user focus in documentation approach.
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.

1 participant