betaflight / betaflight.com

49 stars 75 forks source link

Prepare Board documentation for new format docs #398

Closed VitroidFPV closed 5 months ago

VitroidFPV commented 5 months ago

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. image

The first entry takes from the provided example, more will be added as manufacturers/developers contribute docs for newly released (and maybe existing) boards.

netlify[bot] commented 5 months ago

Deploy Preview for origin-betaflight-com ready!

Name Link
Latest commit 5ada9383b926fc2923db7f429cc56e54ff0c04b5
Latest deploy log https://app.netlify.com/sites/origin-betaflight-com/deploys/66042244fdba190008cbdfc8
Deploy Preview https://deploy-preview-398--origin-betaflight-com.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

haslinghuis commented 5 months ago

@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.

VitroidFPV commented 5 months ago

Writing some instructions on how to submit the documentation as well, will push up in a little bit

VitroidFPV commented 5 months ago

I will rename it accordingly. The Current category serves to only show the documentation files that follow the new standard. I will try to set some time apart to write up the boards I have on hand

haslinghuis commented 5 months ago

Thank you - much appreciated - please check attached configurator PR to keep in sync.

haslinghuis commented 5 months ago

There is no new preview - so can not check without building local

image

Is the BOARD being duplicated in the path?

VitroidFPV commented 5 months ago

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

VitroidFPV commented 5 months ago

Please review the documentation guide and recommend any potential changes. Other than that I think it's good to go 😅

nerdCopter commented 5 months ago

What is the difference between Archive and Legacy? i.e. should they be combined, or no?

VitroidFPV commented 5 months ago

What is the difference between Archive and Legacy? i.e. should they be combined, or no?

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

sonarcloud[bot] commented 5 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

nerdCopter commented 5 months ago

this repo properly dismisses approvals upon new commits. other repos do not, but such is convenient.