Skip to content
This repository has been archived by the owner on May 26, 2023. It is now read-only.

Add documentation for nav sim hotkeys #505

Merged
merged 6 commits into from
Nov 29, 2020
Merged

Conversation

amverni
Copy link
Member

@amverni amverni commented Nov 20, 2020

resolves #431

Add a wiki detailing what each hotkey does as well as what file that hotkey is implemented.

This changes was tested by viewing the wiki on my fork to verify it rendered properly.

Copy link
Contributor

@raytitan raytitan left a comment

Choose a reason for hiding this comment

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

Should these tiny commits be squashed together?

@amverni
Copy link
Member Author

amverni commented Nov 22, 2020

Should these tiny commits be squashed together?

No. I will squash at the end. Up until then it won't matter. We can discuss this more offline if you'd like. It will also be laid out in the new workflow doc which I am concurrently working on. This change is for the example there.

Copy link
Contributor

@aswarner aswarner left a comment

Choose a reason for hiding this comment

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

I left two code comments that need revision. Additionally, this pull request does not address the fourth action item in #431 , which is to include the hotkeys from FieldItems.vue

simulators/nav/src/components/README.md Show resolved Hide resolved
simulators/nav/src/components/hotkeys.md Outdated Show resolved Hide resolved
@amverni
Copy link
Member Author

amverni commented Nov 24, 2020

I left two code comments that need revision. Additionally, this pull request does not address the fourth action item in #431 , which is to include the hotkeys from FieldItems.vue

You're right! That should definitely be a part of this PR.

Copy link
Contributor

@aswarner aswarner left a comment

Choose a reason for hiding this comment

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

Thanks for addressing my comments! Looks good to squash and merge

@amverni amverni merged commit 6ab3c55 into umrover:main Nov 29, 2020
@amverni amverni deleted the hotkey-docs branch November 29, 2020 21:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a documentation page detailing all of the hotkeys
4 participants