This project contains my common tools, utilitites, pre-commit hooks, anything that can be generalized and provide value as a baseline for all of my other work.
This pull request includes a comprehensive overhaul of the project's documentation. The changes aim to improve clarity, structure, and usability for contributors and users. The following documents have been revised or newly added:
contributing.md:
Drafted initial contributing guidelines.
Revised and reordered sections for better readability and flow.
pre_commit.md:
Drafted documentation for pre-commit tools.
Implemented detailed guidelines on setting up and using pre-commit hooks.
documentation.md:
Drafted an approach for maintaining and updating repository documentation.
getting_started.md:
Drafted initial getting started guide.
Heavily revised to include step-by-step instructions for new users.
README.md:
Revised the README to link out to more detailed docs rather than duplicate information.
Improved overall structure and flow
docs:
Revised and integrated various documentation files to ensure consistency and completeness.
nitpick configuration:
Updated repository URL links in nitpick config to point to the org repo.
Fixed broken links to old personal repo.
Commits
docs(contributing.md): draft contributing.md
docs(contributing.md): revise and reorder contribution docs
docs(pre_commit.md): draft pre_commit tools docs
docs(pre-commit.md): implement pre-commit docs
docs(documentation.md): draft docs approach for repo
docs(getting_started.md): draft getting started docs
docs(getting_started.md): revise getting started docs heavily
docs(README): revise README and add placeholder docs
docs(docs): revise and integrate docs
fix: reference org repo in cookiecutter nitpick config
Checklist
[x] Documentation has been updated as per the new guidelines.
[x] All new and existing tests pass.
[x] Commit messages follow the conventional commit format.
Related Issues
None
Notes
Please review the changes and provide feedback. Thank you for your contributions to Strangebasis!
This pull request includes a comprehensive overhaul of the project's documentation. The changes aim to improve clarity, structure, and usability for contributors and users. The following documents have been revised or newly added:
contributing.md:
pre_commit.md:
documentation.md:
getting_started.md:
README.md:
docs:
nitpick configuration:
Commits
Checklist
Related Issues
Notes
Please review the changes and provide feedback. Thank you for your contributions to Strangebasis!
@strangebasis