strangebasisdevs / strangebasis

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.
GNU Affero General Public License v3.0
0 stars 0 forks source link

Documentation Overhaul and New Guidelines #2

Closed strangebasis closed 3 days ago

strangebasis commented 3 days ago

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:

  1. contributing.md:

    • Drafted initial contributing guidelines.
    • Revised and reordered sections for better readability and flow.
  2. pre_commit.md:

    • Drafted documentation for pre-commit tools.
    • Implemented detailed guidelines on setting up and using pre-commit hooks.
  3. documentation.md:

    • Drafted an approach for maintaining and updating repository documentation.
  4. getting_started.md:

    • Drafted initial getting started guide.
    • Heavily revised to include step-by-step instructions for new users.
  5. README.md:

    • Revised the README to link out to more detailed docs rather than duplicate information.
    • Improved overall structure and flow
  6. docs:

    • Revised and integrated various documentation files to ensure consistency and completeness.
  7. nitpick configuration:

    • Updated repository URL links in nitpick config to point to the org repo.
    • Fixed broken links to old personal repo.

Commits

Checklist

Related Issues

Notes

Please review the changes and provide feedback. Thank you for your contributions to Strangebasis!


@strangebasis