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

Update the CSS file & fix documentation errors #134

Open
1 of 7 tasks
adelgadoj3 opened this issue Jan 24, 2024 · 0 comments
Open
1 of 7 tasks

Update the CSS file & fix documentation errors #134

adelgadoj3 opened this issue Jan 24, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@adelgadoj3
Copy link
Collaborator

adelgadoj3 commented Jan 24, 2024

The CSS file needs to be updated. In the top right hand corner of the page, similar to how it is displayed on the Micronaut documentation, there should be links to:

  • Java docs (placeholder until material is finalized)
  • API reference
  • Community guidelines
  • Contributor License Agreement
  • TOC text is now staggered. Text should be aligned as it previously was. (see below)
  • Make sure "Improve this doc" is next to the component name which is currently in the next line.
  • Some of the "Improve this doc" are pointing to the develop branch, changed it to the main branch.

Optional:
For ease of use in future iterations of this project it may be recommended to re-design the CSS file with proper documentation. This will allow for easier changes and updates to the file.


Screenshot 2023-11-29 175121

@adelgadoj3 adelgadoj3 added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 24, 2024
@adelgadoj3 adelgadoj3 self-assigned this Jan 24, 2024
@ruthvikm ruthvikm moved this from 🆕 New to 🏗 In progress in Pi4Micronaut Backlog Jan 24, 2024
@ruthvikm ruthvikm changed the title Update the CSS file Update the CSS file & fix documentation errors Jan 24, 2024
@adelgadoj3 adelgadoj3 linked a pull request Feb 5, 2024 that will close this issue
@ruthvikm ruthvikm moved this from 🏗 In progress to 📋 Backlog in Pi4Micronaut Backlog Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: 📋 Backlog
Development

Successfully merging a pull request may close this issue.

1 participant