Skip to content

docs(standards): update documentation for better maintenance#167

Merged
halvaradop merged 5 commits intomasterfrom
docs/update-documentation
Jun 5, 2025
Merged

docs(standards): update documentation for better maintenance#167
halvaradop merged 5 commits intomasterfrom
docs/update-documentation

Conversation

@halvaradop
Copy link
Owner

@halvaradop halvaradop commented Jun 5, 2025

Description

This PR improves the project documentation to help future maintainers and contributors better understand the structure and standards.

Key Changes

  • Updated README.md with clearer setup and usage instructions
  • Improved contribution guidelines in CONTRIBUTING.md
  • Added new ARCHITECTURE.md to describe the overall folder and code structure

Checklist

  • Added documentation.
  • The changes do not generate any warnings.
  • I have performed a self-review of my own code
  • All tests have been added and pass successfully

Notes

@halvaradop halvaradop added the documentation Improvements or additions to documentation label Jun 5, 2025
@halvaradop halvaradop changed the title docs/update documentation docs(standards): update documentation for better maintenance Jun 5, 2025
@github-project-automation github-project-automation bot moved this to Backlog in @halvaradop Jun 5, 2025
@halvaradop halvaradop merged commit c0427e6 into master Jun 5, 2025
3 checks passed
@github-project-automation github-project-automation bot moved this from Backlog to Done in @halvaradop Jun 5, 2025
@halvaradop halvaradop deleted the docs/update-documentation branch June 5, 2025 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant