[AISOS-2125] Add quick start instructions to forge readme.md#125
Closed
forgeSmith-bot wants to merge 1 commit into
Closed
[AISOS-2125] Add quick start instructions to forge readme.md#125forgeSmith-bot wants to merge 1 commit into
forgeSmith-bot wants to merge 1 commit into
Conversation
Detailed description: - Updated the 'Quick Start' section in README.md to list Prerequisites, Core Services (Redis Stack, API gateway, worker, and container build instructions), and Optional Observability Services (Prometheus, Grafana, and Langfuse tracing configuration). - Injected a new test file 'tests/unit/test_readme_integrity.py' to programmatically verify that all required commands, paths, and configurations are correctly documented. Closes: AISOS-2125
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces comprehensive local setup and "Quick Start" instructions to the Forge repository's primary
README.md. Providing clear onboarding guidelines and explicit execution steps lowers the friction for new developers, standardizes local environment parity, and simplifies running both core application services and optional observability tools.Changes
Documentation
README.md: Revamped the "Quick Start" section to include clear prerequisites, concrete instructions for starting core services (Redis Stack, API gateway, and background worker), and guidelines for building container images.Testing & Quality Assurance
tests/unit/test_readme_integrity.py: Added a programmatic integrity test to verify that key developer paths, Docker Compose references (devtools/docker-compose.dev.yml), commands, and environment variables listed in the README remain valid and structured correctly.Implementation Notes
CLAUDE.mddevelopment guidelines.devtools/docker-compose.dev.ymlensures that local backing databases and metrics exporters are run in a uniform containerized environment, reducing manual host configuration.Testing
pytest tests/unit/test_readme_integrity.py).Related Tickets
Generated by Forge SDLC Orchestrator