Skip to content
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.

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

Fix Missing Documentation Includes & UI Rendering Issues #311

Closed
3 tasks done
yrlmanoharreddy opened this issue Feb 10, 2025 · 0 comments
Closed
3 tasks done

Fix Missing Documentation Includes & UI Rendering Issues #311

yrlmanoharreddy opened this issue Feb 10, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@yrlmanoharreddy
Copy link
Collaborator

yrlmanoharreddy commented Feb 10, 2025

Description:
This issue addresses two documentation-related problems:

Developer Notes:

  1. Missing Documentation Includes (Add Missing Documentation Includes in index.adoc #310)

The index.adoc file is missing include:: statements for several input components, preventing them from appearing in the main documentation.
Components such as PIRSensorHelper and PhotoResistorHelper need to be properly included.

  1. UI Rendering Issues in AsciiDoc Documentation (Fix UI Bug in Pi4Micronaut Documentation (Text Visibility Issue) #299)

The rendered documentation page has UI bugs where certain portions of the text are not fully visible.
This may be due to improper styling, layout configuration, or AsciiDoc rendering errors.
The documentation layout should be reviewed and fixed to ensure proper visibility of all content.

Acceptance Criteria:

  • index.adoc includes all necessary include:: statements, and missing components appear in the main documentation.
  • No UI rendering issues—text and formatting should display correctly.
  • The final rendered documentation is clear, readable, and fully visible.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

2 participants