Skip to content

Conversation

@MYousuf3
Copy link
Collaborator

No description provided.

@MYousuf3 MYousuf3 requested review from i3ta and kjohnsen February 13, 2025 21:39
Copy link
Contributor

@kjohnsen kjohnsen left a comment

Choose a reason for hiding this comment

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

(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 scripts and update-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.

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.

3 participants