[AISOS-2161] Show all supported Forge workflows on the documentation home page#151
Open
forgeSmith-bot wants to merge 4 commits into
Open
[AISOS-2161] Show all supported Forge workflows on the documentation home page#151forgeSmith-bot wants to merge 4 commits into
forgeSmith-bot wants to merge 4 commits into
Conversation
…qually Detailed description: - Updated the Forge documentation home page (docs/index.md) to clearly highlight all three supported workflows (Feature, Bug, and Task workflows) with equal prominence. - Replaced the single-workflow diagram with a comprehensive diagram representing all three entrypoints and processing paths leading to implementation and delivery. - Added a dedicated 'Supported Workflows' section with clear 'When to use' descriptions and relative links to their respective detailed guide markdown files. - Preserved a prominent path for first-time users to get started. - Created and executed a new test file tests/unit/test_docs_homepage.py to verify structure and links. Closes: AISOS-2161
Auto-committed by Forge container fallback.
Detailed description: - Replaced the hardcoded absolute path '/workspace/docs/index.md' in tests/unit/test_docs_homepage.py with a dynamically resolved absolute path based on the directory location of the test file. - Ensures the test correctly locates documentation files relative to the project root in diverse virtualized/local environment setups. Closes: AISOS-2161-ci-fix
Detailed description: - Added explicit type annotations to tests/unit/test_docs_homepage.py to fully satisfy Mypy type-checking requirements. - Addressed code style issues identified by Ruff, including unused modes in file opens, trailing spaces, and sorted imports. - Performed verification using local test execution. Closes: AISOS-2161-review-ci-fix-1
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
1 participant
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 updates the Forge documentation home page to provide balanced, comprehensive visibility across all three core workflows: Feature, Bug, and Task workflows. By dismantling the previous bias toward the feature workflow and establishing clear, equal prominence for each path, this change ensures users can easily select the precise entry point that aligns with their engineering needs, accelerating onboarding and reducing friction.
Changes
Documentation Updates
docs/index.md: Restructured the home page to highlight the three supported workflows (Feature, Bug, and Task) with equal visual and textual weight, incorporating a comprehensive diagram representing all three entrypoints and processing paths leading to implementation and delivery.Quality Assurance & Testing
tests/unit/test_docs_homepage.py: Introduced a new unit test suite to verify the structural integrity, markdown links, and filesystem validity of the updated documentation home page.Implementation Notes
--noconftestto bypass heavy application-level dependencies, dynamically resolving the path to documentation files relative to the test file location to ensure portability across virtualized and local environments.Testing
zensical build.pytest tests/unit/test_docs_homepage.py --noconftestto ensure all relative documentation links, terminology, and content structures are valid and exist in the filesystem.Related Tickets
Generated by Forge SDLC Orchestrator