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

Docs update #39

Merged
merged 10 commits into from
Mar 23, 2023
Merged

Docs update #39

merged 10 commits into from
Mar 23, 2023

Conversation

quarkytale
Copy link
Contributor

@quarkytale quarkytale commented Mar 22, 2023

hamilton8415 and others added 5 commits March 21, 2023 08:20
@quarkytale quarkytale requested a review from hamilton8415 March 22, 2023 06:55
@github-actions
Copy link

github-actions bot commented Mar 22, 2023

PR Preview Action v1.3.0
Preview removed because the pull request was closed.
2023-03-23 20:38 UTC

@quarkytale quarkytale marked this pull request as draft March 22, 2023 07:00
Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
@quarkytale quarkytale requested a review from mabelzhang March 22, 2023 18:21
@quarkytale
Copy link
Contributor Author

quarkytale commented Mar 22, 2023

So according to PythonMarkdown differences https://python-markdown.github.io/#differences, 4 spaces in multiple paragragh of a list item should fix indexing in the documentation. That solved it locally for me, but not sure why gh-pages still doesn't increment and keeps resetting to 1. Thoughts @mabelzhang?

Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
@quarkytale
Copy link
Contributor Author

Okay seemed to have worked with twice as many spaces for code blocks (8 spaces) than the usual text (4 spaces).

@quarkytale quarkytale marked this pull request as ready for review March 22, 2023 19:55
@mabelzhang
Copy link
Collaborator

mabelzhang commented Mar 23, 2023

I think it makes sense to target this to main, and then merge main into #37. There are already changes in this PR that are new from main that #37 still needs to merge from main and resolve conflicts with.

@hamilton8415
Copy link
Collaborator

Thanks for figuring out this numbering issue. I think mabel's merge strategy seems fine and we could just go ahead and proceed, we will continue to be adjusting these docs so things don't need to be super finalized.

@quarkytale quarkytale changed the base branch from hamilton8415/fs_hydrodynamics to main March 23, 2023 18:20
@quarkytale quarkytale requested a review from andermi March 23, 2023 18:30
Copy link
Collaborator

@andermi andermi left a comment

Choose a reason for hiding this comment

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

Unfortulately, some of the backticks are showing up in the code blocks

image

Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
Copy link
Collaborator

@andermi andermi left a comment

Choose a reason for hiding this comment

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

that worked! LGTM

@quarkytale quarkytale merged commit 8fcb61a into main Mar 23, 2023
@quarkytale quarkytale deleted the docs_update branch March 23, 2023 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants