-
Notifications
You must be signed in to change notification settings - Fork 18
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
Create a documentation directory and updating the serial subsystem docs #156
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Courtney Darville <courtneydarville94@outlook.com>
Signed-off-by: Courtney Darville <courtneydarville94@outlook.com>
Signed-off-by: Courtney Darville <courtneydarville94@outlook.com>
Signed-off-by: Courtney Darville <courtneydarville94@outlook.com>
Signed-off-by: Courtney Darville <courtneydarville94@outlook.com>
Signed-off-by: Courtney Darville <courtneydarville94@outlook.com>
I'm halfway through on a block doc aswell, will put that into this PR when im closer to finishing |
I'd like to discuss with others in the team the role of this documentation vs the design doc before reviewing. I don't have any strong opinions on whether we should have everything in one place or not, but I do want to understand what belongs in the design doc and what belongs in these more technical docs. |
I haven't looked closely yet but one good addition would be listing exactly what drivers we have and any setup they need. Right now we have stuff like this in the Makefile:
Other than the last line about So for serial we should have something like:
|
examples/serial/README.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be showing example output, we should always include example output of what the system should look like when you boot it up so people know if they've done the right thing or not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There used to be a section called "Running/using" https://github.com/au-ts/sddf/blob/95492dcc32abf8f8b4fc34297ba5c26fb181d891/examples/serial/README.md#runningusing.
We should have that.
docs/blk.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@erichchan999 can you put this in a separate PR, it'll be hard to address feedback for two people's work in the same PR. It's fine for your PR to just be based of Courtney's branch,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure, i'll undo those commits
## System architecture | ||
|
||
The serial subsystem adheres to the sDDF design principles of modularalised components split via | ||
separation of concerns which communicate via shared data structures and microkit channels. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
separation of concerns which communicate via shared data structures and microkit channels. | |
separation of concerns which communicate via shared data structures and asynchronous notifications (Microkit channels). |
The serial subsystem adheres to the sDDF design principles of modularalised components split via | ||
separation of concerns which communicate via shared data structures and microkit channels. | ||
|
||
In order to transmit and receive via the uart device, clients of the system must interface with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In order to transmit and receive via the uart device, clients of the system must interface with | |
In order to transmit and receive via the UART device, clients of the system must interface with |
Before addressing any feedback I would suggest rebasing since there might be some conflicting changes in the serial example since the PR got made. |
38ac70d
to
b42cb19
Compare
This pull request aims to provide an example of a preferred style of documentation. Firstly, it adds a
docs
directory to the repo, which contains developer targeted documentation for using each sDDF subsystem. Secondly, it restricts the README.md documentation in the serial example to more specifically provide details of the example, leaving general subsystem informations fordocs/serial.md
.Once a convention for such documentation is agreed upon, we should aim to update the remaining sDDF subsystems.