Skip to content
This repository was archived by the owner on Feb 22, 2026. It is now read-only.

feat: Restructure README#151

Merged
NewJerseyStyle merged 8 commits intoedge-civictechtofrom
feature/issue-new-readme-149
Feb 22, 2026
Merged

feat: Restructure README#151
NewJerseyStyle merged 8 commits intoedge-civictechtofrom
feature/issue-new-readme-149

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
@NewJerseyStyle NewJerseyStyle marked this pull request as ready for review February 22, 2026 06:41
Copy link
Member Author

@NewJerseyStyle NewJerseyStyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ready to archive this repo

@NewJerseyStyle NewJerseyStyle merged commit 6afbf58 into edge-civictechto Feb 22, 2026
1 check passed
@NewJerseyStyle NewJerseyStyle deleted the feature/issue-new-readme-149 branch February 22, 2026 06:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

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