docs: Add documentation for F' subtopologies #2743
Conversation
There was a problem hiding this comment.
This document should likely be linked in the documentation's navigation/indexes:
- https://github.com/nasa/fprime/blob/devel/docs/_includes/toc.md
- https://github.com/nasa/fprime/blob/devel/docs/HowTo/general.md.
Also subtopology and subtopologies should be added to spellcheck: https://github.com/nasa/fprime/blob/devel/.github/actions/spelling/expect.txt
There was a problem hiding this comment.
Should the fprime-util new feature (nasa/fprime-tools#203) be documented in this guide?
Up to you. Will that be pushed before the docs? |
|
Finally we pass spell check 😁 |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
There was a problem hiding this comment.
@mosa11aei this is awesome! I was very much of a noob when it comes to subtopology, and I now feel much more educated!
As a novice, I had a lot of comments/questions. Please just take them as suggestions, this is in no way critical. This is an amazing guide, very clear, the example is really descriptive of the kind of capability subtopologies offers.
Woohoo 🎉
|
@thomas-bc Thanks for your comments, and I apologize for the delay in reviewing them! They should all be addressed. @thomas-bc @LeStarch according to our discussions, I've written the document to now only use phases. A couple things before this is ready for review and merge:
|
Change Description
F' subtopologies are a very powerful tool to allow for breaking out one large topology into smaller, more manageable and reusable ones. This PR provides documentation on this tool.