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.

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

Jump to bottom

Fixing the Documentation #136

Closed
ruthvikm opened this issue Jan 24, 2024 · 1 comment
Closed

Fixing the Documentation #136

ruthvikm opened this issue Jan 24, 2024 · 1 comment
Assignees
@adelgadoj3
Labels
documentation Improvements or additions to documentation

Comments

@ruthvikm
Copy link
Collaborator

Add 3 buttons in the header section of the documentation for

  • API References (for Javadocs)
  • Community Guidelines (point it to the communityguidelines.md)
  • CLA (point it to the CLA.md)

Fix the Table of Contents width. So that it looks clean.

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.
@ruthvikm ruthvikm added the documentation Improvements or additions to documentation label Jan 24, 2024
@ruthvikm ruthvikm moved this from 🆕 New to 🏗 In progress in Pi4Micronaut Backlog Jan 24, 2024
@ruthvikm
Copy link
Collaborator Author

Duplicate for #134

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Pi4Micronaut Backlog Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adelgadoj3 adelgadoj3

Labels
documentation Improvements or additions to documentation
Projects
Pi4Micronaut Backlog
Status: ✅ Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ruthvikm @adelgadoj3