Installation guide updates/fixing link to installations#33
Open
Installation guide updates/fixing link to installations#33
Conversation
kjohnsen
requested changes
Feb 27, 2025
Contributor
kjohnsen
left a comment
There was a problem hiding this comment.
(copied from Slack)
About your PR with updated install instructions---looks like you edited the built docs (Hugo-generated HTML) directly. We should be editing the Markdown source in misc/docs-hugo instead and then generating the docs from that. Can you do that instead? In addition, can you do the following?
- make sure we didn't make the mistake of editing HTML instead of the source Markdown on the last few changes to the docs
- both these should run if you
cd scriptsandupdate-docs.sh. you'll need Hugo (maybe a specific version) and Doxygen- regenerate the doxygen API docs (in case there are any new things, though I don't think we've touched the C++ doc comments)
- regenerate the Hugo docs
- put instructions somewhere (maybe in README.md? the contributing page?) about editing/generating docs so we don't miss this again
- add a short section, maybe a paragraph or two, to the control-estimation page about MPC? You'll probably want to look at lqmpc for inspiration, but I wouldn't get into all the detail of how the quadratic program is set up. Just the main idea, the cost function over the horizon, etc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.