Skip to content

chore: update documentation and default repo-path path for better clarity #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zaperex merged 7 commits into from
Jan 20, 2026
Merged

chore: update documentation and default repo-path path for better clarity #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5d5983f
chore: fix types and switch default repo-path to `/source` for clarity
Zaperex Jan 6, 2026
dd2649f
docs: update default repo path to `/source` for clarity
Zaperex Jan 6, 2026
ea669cb
doc: update with common issue troubleshooting
Zaperex Jan 12, 2026
f6de10c
Merge branch 'main' of github.com:redhat-developer/rhdh-dynamic-plugi…
Zaperex Jan 12, 2026
f73cc48
test: update unit tests with a configurable config fixture
Zaperex Jan 16, 2026
28fb326
chore: remove unused imports
Zaperex Jan 16, 2026
8c66848
chore: update cursor rules
Zaperex Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions .cursor/rules/documentation-standards.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,13 +249,6 @@ EOF
- Align multi-line comments for readability
- Use consistent comment block formatting

## pdoc Documentation Rules
- Use `pdoc` for API documentation generation from Python source
- **Strictly use Google Style Docstrings** for all code elements
- Document public variables using PEP 224 docstrings or `#:` doc-comments
- Generated documentation located in `docs/sidekick/`
- Target audience: developers and LLMs

## Google Style Docstring Format
```python
def function_name(param1: str, param2: int) -> bool:
Expand Down
Loading