Skip to content

docs: repo cleanup and professional README/docs (#91) - #92

Merged
ZhuchkaTriplesix merged 3 commits into
devfrom
issue/91-repo-docs-cleanup
Jun 13, 2026
Merged

docs: repo cleanup and professional README/docs (#91)#92
ZhuchkaTriplesix merged 3 commits into
devfrom
issue/91-repo-docs-cleanup

Conversation

@ZhuchkaTriplesix

Copy link
Copy Markdown
Member

Summary

  • Add repository audit (docs/archive/AUDIT.md) and move historical spikes/plans into docs/archive/.
  • Introduce structured docs: index (docs/README.md), getting started, and architecture guide.
  • Rewrite README.md with badges, highlights, and a documentation index; expand CONTRIBUTING.md with GitFlow and pre-PR checklist.
  • Stop tracking generated .flutter-plugins-dependencies (already in .gitignore).
  • Update cross-links in theme.md, roadmap.md, and CHANGELOG.md.

Closes #91

Test plan

  • Verified all markdown links resolve locally
  • Changes are docs-only (no Dart code touched)
  • Review README and docs index in GitHub preview

Restructure documentation with a docs index, architecture guide, and
expanded contributing guide; archive historical spikes; stop tracking
generated .flutter-plugins-dependencies.
Stop tracking Cursor rules; keep them local-only per developer setup.
Keep the file untracked — it is generated locally and listed in .gitignore.
@github-actions github-actions Bot added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 13, 2026
@ZhuchkaTriplesix
ZhuchkaTriplesix merged commit ef51806 into dev Jun 13, 2026
3 checks passed
@ZhuchkaTriplesix
ZhuchkaTriplesix deleted the issue/91-repo-docs-cleanup branch June 13, 2026 20:09
ZhuchkaTriplesix added a commit that referenced this pull request Jul 27, 2026
docs: repo cleanup and professional README/docs (#91)
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant