Prepare Board documentation for new format docs #398
Conversation
✅ Deploy Preview for origin-betaflight-com ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@VitroidFPV please note the board needs to be uppercase as detected by firmware. Also some boards like KAKUTE were recently updated - but perhaps not using new standard - if the intention is to start fresh. |
|
Writing some instructions on how to submit the documentation as well, will push up in a little bit |
|
I will rename it accordingly. The |
|
Thank you - much appreciated - please check attached configurator PR to keep in sync. |
|
There is no new preview - so can not check without building local
Is the BOARD being duplicated in the path? |
The document file itself is in a directory of the same name. That basically just allows a directory containing multiple files to show up as a single document in the sidebar - so that we can have a folder with all the images at the same directory level as the board documentation file without introducing a lot of clutter |
|
Please review the documentation guide and recommend any potential changes. Other than that I think it's good to go 😅 |
| @@ -0,0 +1,105 @@ | |||
| # How to Create Board Documentation | |||
|
|
|||
| The newly created board documentation format is made to take full advantage of the features available with the documentation platform in use - docusaurusVersion. It is extended with features not present in the default markdown format, and may be more complex to work with. | |||
There was a problem hiding this comment.
docusaurusVersion ?
Also might add a link to markdown format
There was a problem hiding this comment.
Autocomplete showing up where it really shouldn't 😅 I'll fix it and add a link to some markdown resources
|
What is the difference between |
Archive has board docs for boards that should still be supported, but don't follow the updated format. Legacy is for old F1/F3 boards. I thought about deleting those entirely, but this PR is just for organization |
|
|
this repo properly dismisses approvals upon new commits. other repos do not, but such is convenient. |
As new target submissions will be strongly encouraged to provide documentations and/or board samples for developer verification + documentation, there should be a clear distinction between the old and the new pages.
The first entry takes from the provided example, more will be added as manufacturers/developers contribute docs for newly released (and maybe existing) boards.