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

Add missing documentation links #192

Merged
merged 2 commits into from
May 20, 2023
Merged

Add missing documentation links #192

merged 2 commits into from
May 20, 2023

Conversation

glpuga
Copy link
Collaborator

@glpuga glpuga commented May 20, 2023

Proposed changes

Adds missing documentation links:

  • BeamSensorModel in Sensors page
  • WeightedStateEstimator in StateEstimation page

Adds a section with a link to the Doxygen documentation from the Beluga README.md (before the only link was in the landing page of the repository).

Also fixes the path to the document generation script in GETTING_STARTED.md

Type of change

  • 🐛 Bugfix (change which fixes an issue)
  • 🚀 Feature (change which adds functionality)
  • 📚 Documentation (change which fixes or extends documentation)

Checklist

Put an x in the boxes that apply. This is simply a reminder of what we will require before merging your code.

  • Lint and unit tests (if any) pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • All commmits have been signed for DCO

Signed-off-by: Gerardo Puga <glpuga@ekumenlabs.com>
@glpuga glpuga requested a review from nahueespinosa May 20, 2023 18:43
Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

beluga/README.md Outdated Show resolved Hide resolved
@nahueespinosa nahueespinosa added documentation Improvements or additions to documentation enhancement New feature or request labels May 20, 2023
Co-authored-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
Signed-off-by: Gerardo Puga <glpuga@gmail.com>
@glpuga glpuga merged commit 3ed2634 into main May 20, 2023
5 checks passed
@glpuga glpuga deleted the glpuga/docs branch May 20, 2023 22:35
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
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants