Updating syseng docs and prepping for easier version updating #25
Conversation
Signed-off-by: John 'Warthog9' Hawley <[email protected]>
We need a place to more easily track what version of the firmware is current / active. This gives us an easy place to do a pull request against as well as pull into the docs themselves Signed-off-by: John 'Warthog9' Hawley <[email protected]>
Signed-off-by: John 'Warthog9' Hawley <[email protected]>
This should make dealing with the versions slightly easier Signed-off-by: John 'Warthog9' Hawley <[email protected]>
There was a problem hiding this comment.
When I view the markdown, I don't see the formatting. Is this expected because I don't have the extensions enabled, but they will be on the live site?
There was a problem hiding this comment.
I'm making use of templating so if you haven't actually rendered these with sphinx, you are going to see the raw templating you are seeing.
There was a problem hiding this comment.
Can I suggest that we use these changes, but have them in the quickstart instead?
Let's replace the generic instruction for sending a user to the tt-kmd repo with the instruction from here on how to install kmd, firmware, etc.
|
Again, the repos themselves are going to have developer centric README.md's, they aren't intended for end users - so no we don't want to point end users at the repositories themselves. Once we have packaging the user should realistically never have to interact with the git repository itself. End user documentation is a very different thing vs. developer centric documentation, there's a reason we wrote these docs and kept them where the end users would interact with them. If the quickstart is doing otherwise then that's going to make for a very uneven user experience, and sets a bad president for when we have proper packaging and such, which is in progress right now. |
Aligned. My comment is to take the instructions you are proposing for this PR and move them to https://github.com/tenstorrent/tenstorrent.github.io/blob/main/core/quickstart.md. So, instead of updating The readme's within each repo remain unchanged and are developer focused only. |
No description provided.