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

--Docs cleanup #2238

Merged
merged 9 commits into from
Oct 24, 2023
Merged

--Docs cleanup #2238

merged 9 commits into from
Oct 24, 2023

Conversation

jturner65
Copy link
Contributor

@jturner65 jturner65 commented Oct 12, 2023 •
edited

Motivation and Context

Our documentation build has thousands of warnings and broken references. This PR is an attempt to clean some of this up for Habitat 3.0 release.

This is part of what is going to be an ongoing effort at improving the Habitat-Sim documentation build to the point where it is ideally warning-free.

How Has This Been Tested

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Oct 12, 2023
@jturner65 jturner65 marked this pull request as ready for review October 24, 2023 18:27
aclegg3
aclegg3 approved these changes Oct 24, 2023
View reviewed changes
Copy link
Contributor

@aclegg3 aclegg3 left a comment

Choose a reason for hiding this comment

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

Thanks! Chipping away at missing/broken docs. 💪

@jturner65 jturner65 merged commit 7cee5da into main Oct 24, 2023
10 checks passed
@jturner65 jturner65 deleted the DocsCleanup branch October 24, 2023 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aclegg3 aclegg3 aclegg3 approved these changes

Assignees
No one assigned
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@jturner65 @aclegg3 @facebook-github-bot