docs(BLE): HCI Docs Integrated #813
Conversation
There was a problem hiding this comment.
@EricB-ADI I fixed some minor formatting errors. Make sure you've got an empty line above and below each table, otherwise they'll get misformatted.
In general I think the formatting could use a little more work, it's a little hard to read and parse the info. Some images/diagrams would improve it I think
|
@Jake-Carter It was autogenerated from a word doc, so I will have to manually fix a bunch. Do you have any suggestions for formatting? |
There was a problem hiding this comment.
@EricB-ADI here are some more detailed formatting suggestions
| | ------- | ---------------------------------------------- | --------------- | ---------- | | ||
| | 0x300 | 5 + N, where N is the number of bytes to write | Length, Address | Status | | ||
| | | | ||
| #### Description |
There was a problem hiding this comment.
I suggest getting rid of the "Description" and "Return" headers completely. Put the description and return right under the main header.
I'd also suggest noting the packet type (even though they're all the same) and adding curly braces around the parameters to indicate they're an in-order sequence.
Ex:
### Write Memory
Write N bytes to a specified 32-bit address.
Returns a status byte.
Packet type: Command Packet
|**OGF**| **OCF** | ** Length (bytes) ** | * *Parameters** | **Return** |
| ----- | ------- | ------------------- | ------------------- | ---------- |
| 0x3F | 0x300 | 5 + N | {Length, Address} | Status |
_where N is the number of bytes to write_
#### Parameters
...There was a problem hiding this comment.
Also... shouldn't the data bytes you want to send be a parameter for this function?
There was a problem hiding this comment.
I understand this case, but some return a lot of data. For consistency I kept the section. You seem to have more experience, so I can hybridize the approach if you think its better.
github-actions
bot
added
the
documentation
|
Thanks @EricB-ADI just did some more updates to the formatting. After going through the whole thing I agree with your points above. FYI I also consolidated into the primary Cordio UG markdown file. I know it would be ideal to compartmentalize into separate files, but getting the nav bar working is more important.
|
|
@Jake-Carter Thank you very much sir. FYI there will be a lot more docs being added as we create more tools in the coming months. |
Description
Integrated HCI docs into main cordio doc