Skip to content

Conversation

NewJerseyStyle
Copy link
Member

This PR significantly restructures the project's documentation to improve clarity, usability, and maintainability. The main README.md has been streamlined to provide a concise overview and direct users to the appropriate resources. Detailed documentation has been moved to separate files, and new guides for deployment and contributing have been added.

Changes:

  • README.md:

    • Rewritten for conciseness and clarity, focusing on different user types (users, developers, DevOps).
    • Introduces a "Quick Links" section for easy access to key resources.
    • Simplifies the "Getting Started" section, focusing on the core make start command.
    • Directs users to docs/deployment.md for deployment instructions and CONTRIBUTING.md for contribution guidelines.
    • Clearly identifies the project as the CivicTech fork and prioritizes the CivicTech deployment link.
    • Distinguishes between issue tracking for the fork and the upstream repository.
    • Added Development Tooling section and troubleshooting.
  • docs/deployment.md (NEW):

    • Provides comprehensive instructions for deploying the CivicTech fork to Azure App Service.
    • Includes Azure-specific steps and configurations.

@NewJerseyStyle NewJerseyStyle added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 23, 2025
@NewJerseyStyle NewJerseyStyle self-assigned this Mar 23, 2025
@NewJerseyStyle NewJerseyStyle marked this pull request as draft April 9, 2025 21:18
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