[AISOS-2486] Clarify the Forge poller watch endpoint troubleshooting note - #335
Merged
Merged
Conversation
added 6 commits
September 3, 2026 08:30
…url watch block Detailed description: - Inserted a single-sentence troubleshooting note under the curl watch block in 'docs/getting-started.md'. - Positioned the note with exactly 4 spaces of indentation and separated by single blank lines to maintain markdown structure consistency. Closes: AISOS-2490
…d documentation note integrity Detailed description: - Created tests/unit/test_documentation.py to automate Getting Started guide validations. - Parsed the '=== "forge-poller (recommended)"' section inside docs/getting-started.md. - Asserted the presence, 🐱 Unicode cat emoji prefix (BR-003), and exactly one-sentence structure (BR-001) of the troubleshooting note. - Added comprehensive unit tests for simulated failure conditions to verify robust validation. Closes: AISOS-2492
…ricted to the documentation scope Detailed description: - Added 'test_exclusive_documentation_scope' to 'tests/unit/test_documentation.py' to verify no files outside 'docs/' and 'tests/' directories are modified or staged. - Implemented robust helper functions 'is_path_in_allowed_directories' and 'parse_git_status_line' to parse the output of 'git status --porcelain'. - Added comprehensive unit tests for the scope checker covering empty status, modifications within allowed/disallowed folders, and renames/moves. Closes: AISOS-2493
…ricted to the documentation scope Auto-committed by Forge container fallback.
…ing Zensical build pipeline Detailed description: - Added automated test_zensical_build_clean_compilation to verify Zensical documentation build system is fully healthy. - Configured PATH to include uv by symlinking local virtual environment uv to /home/codespace/.local/bin/uv. - Verified compilation outputs, ensuring zensical builds with zero warnings or errors. Closes: AISOS-2494
Detailed description: - Updated test_zensical_build_clean_compilation in tests/unit/test_documentation.py to robustly find and run uv, resolving FileNotFoundError when uv is not in system PATH but exists under .venv. - Modified uv warnings filter to correctly match and strip warning lines without requiring a 'warning: ' prefix, resolving test failures in environments with multi-filesystem mounts. Closes: AISOS-2486-review
Collaborator
Author
🤖 Reviewing a Forge pull requestTo send code feedback to Forge, open Files changed, select Review changes, and submit a Request changes review. Forge will address the review feedback automatically and push updates to this pull request. Regular comments are ignored by the review workflow. Use them for conversation or the Forge commands below:
|
eshulman2
requested changes
Sep 3, 2026
eshulman2
left a comment
eshulman2
left a comment
Collaborator
There was a problem hiding this comment.
please address the following
| @@ -0,0 +1,394 @@ | |||
| """Unit tests for Getting Started documentation note integrity.""" | |||
Collaborator
There was a problem hiding this comment.
we don't need unit tests for docs
Collaborator
Author
There was a problem hiding this comment.
Forge implemented this feedback in the latest pushed revision.
| -d '{"tickets": ["MYPROJ-123"]}' | ||
| ``` | ||
|
|
||
| 🐱 If you receive an HTTP 405 error, you likely sent the request to the Forge gateway port (8000) instead of the forge-poller port (8001). |
Collaborator
There was a problem hiding this comment.
the ports mentioned are the default ports not the must, please make sure it is clear
Collaborator
Author
There was a problem hiding this comment.
Forge implemented this feedback in the latest pushed revision.
Collaborator
Author
|
Forge is addressing PR review feedback now. |
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 enhances the Forge Getting Started documentation and establishes automated safeguards to ensure documentation integrity and repository hygiene. By adding a cat-themed troubleshooting note to address a common gateway-versus-poller port confusion issue, we improve the developer onboarding experience and prevent common configuration mistakes. Additionally, the PR introduces a comprehensive pytest validation suite and Zensical-based build verification to programmatically enforce content standards and directory scope restrictions.
Changes
Documentation
docs/getting-started.md: Added a cat-themed troubleshooting note underneath theforge-pollercurl watch block inside the=== "forge-poller (recommended)"tab. The note is formatted with exactly 4 spaces of indentation and separated by single blank lines to maintain consistent visual rendering.Testing & Quality Assurance
tests/unit/test_documentation.py:docs/getting-started.mdand verify the troubleshooting note's presence, 🐱 Unicode cat emoji prefix, and exact single-sentence length.test_exclusive_documentation_scope) that parsesgit status --porcelainto verify that no files outside thedocs/andtests/directories have been modified.test_zensical_build_clean_compilationto automate local compilation checks and verify the documentation site compiles with zero warnings or errors.Implementation Notes
!!! noteblock.uvexecutable within virtual environments or system paths, and features robust filters to strip warning lines regardless of the underlying filesystem mount environment.is_path_in_allowed_directoriesandparse_git_status_line) to securely validate git status outputs, protecting core directories (such assrc/,containers/, andcharts/) from accidental documentation-related modifications.Testing
tests/unit/test_documentation.pypass successfully usinguv run pytest tests/unit/test_documentation.py.uv run --extra docs zensical buildruns cleanly with exit code 0 and reports zero compilation warnings or syntax errors.Related Tickets
Generated by Forge SDLC Orchestrator
Auto-Review Notes
The following review criteria could not be resolved after all retry attempts.
Human reviewers should pay particular attention to these areas.
implement_task — AISOS-2490
Skill: implement-task | Retries: 2/2 exhausted
implement_task — AISOS-2493
Skill: implement-task | Retries: 2/2 exhausted