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

Building and flashing guide improvements #1395

Merged
merged 5 commits into from
Oct 7, 2024
Merged

Building and flashing guide improvements #1395

merged 5 commits into from
Oct 7, 2024

Conversation

gemenerik
Copy link
Member

@gemenerik gemenerik commented Aug 6, 2024

Main goal of this PR is to clarify that brushless uses a different defconfig

Major changes:

  • Add brushless defconfig tab
  • Remove roadrunner defconfig reference

Minor changes:

  • Consistent code block formatting
  • Retrieve number of processing units rather than assuming 12

@gemenerik gemenerik marked this pull request as ready for review September 9, 2024 11:22
@ataffanel ataffanel self-assigned this Sep 24, 2024
Copy link
Member

@knmcguire knmcguire left a comment

Choose a reason for hiding this comment

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

There is unfortunately an issue, this will break tb docs of the toolbelt of building the documentation locally so it always need to be build as a submodule from the website. It won't know what the meaning of the tab group is otherwise

Another thing ofcourse is that now the markdown itself is less readable by itself. So unfortunately I do think that we need to discuss this break first before merging. We need to align on what is accepted within the repo doc files or not.

@gemenerik
Copy link
Member Author

There is unfortunately an issue, this will break tb docs of the toolbelt of building the documentation locally so it always need to be build as a submodule from the website. It won't know what the meaning of the tab group is otherwise

Another thing ofcourse is that now the markdown itself is less readable by itself. So unfortunately I do think that we need to discuss this break first before merging. We need to align on what is accepted within the repo doc files or not.

The main point of this PR was to make it clear that for brushless people will need to use another defconfig. I removed the Jekyll liquid tags, let's discuss those another time!

@gemenerik gemenerik requested a review from knmcguire September 24, 2024 14:34
Copy link
Member

@knmcguire knmcguire left a comment

Choose a reason for hiding this comment

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

You missed the

make flash

in the section of ###using a debug adapter. But rest looks good! From my part not a blocker so you can also merge as is.

@ataffanel ataffanel assigned knmcguire and unassigned ataffanel Sep 30, 2024
@gemenerik gemenerik merged commit b1a4a00 into master Oct 7, 2024
25 checks passed
@gemenerik gemenerik deleted the bldocs branch October 7, 2024 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants