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

Update to README for T3 2024 #567

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

Conversation

breezy-codes
Copy link
Contributor

Update README

Description

This PR updates the README for the ThothTech Documentation repository to better reflect its role as the hub for short-term documentation. The changes are designed to enhance clarity, organization, and usability for users and contributors. This update provides clearer instructions on the types of documentation expected here, usage examples, and a streamlined structure.

This PR also included adding in npm prettier into the package json, as well as the files that needed to be formatted by prettier.

Key Updates

  1. Refined Focus: Clarified that this repository is intended for short-term, dynamic documentation such as spike reports, meeting minutes, and sprint reports, which are essential during agile development cycles.
  2. Clear Documentation Guidelines: Enhanced the explanation of what constitutes short-term documentation with specific examples and outlined best practices for managing these documents effectively.
  • GitHub Stats: Added badges for GitHub contributors, issues, pull requests, forks, and stars for both SplashKit and Thoth Tech repositories. These stats offer an at-a-glance view of project activity and community engagement.

Motivation

The goal of these changes is to make the README more comprehensive and user-friendly, especially for new contributors and users in preparation for Trimester 3 2024.

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