Skip to content
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

Adding start apps and arguments #2616

Merged
merged 2 commits into from
Apr 9, 2024
Merged

Conversation

LeStarch
Copy link
Collaborator

Related Issue(s)
Has Unit Tests (y/n)
Documentation Included (y/n)

Change Description

Improve plugin docs.

@LeStarch LeStarch requested a review from thomas-bc March 26, 2024 02:02
@LeStarch
Copy link
Collaborator Author

@cgcruz0304 I added you as a reviewer to this issue. I followed your advice and added a TOC and conclusion section. Please let me know if there is anything to be improved.

@LeStarch LeStarch merged commit 17bec56 into nasa:devel Apr 9, 2024
2 checks passed
Copy link
Collaborator

@cgcruz0304 cgcruz0304 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@LeStarch The overall structure and content writing looks good. In future design, rather than having the table of contents in the main content area itself, it can be displayed on the side. MKdocs allows for table of contents to appear on the right column for easier accessibility to page section anchor links. I am curious if this is a one off how-to or if any other relevant material can be added in the end to encourage discoverability of more F Prime resources? Perhaps a "Additional Resources" section if possible?

@LeStarch
Copy link
Collaborator Author

@cgcruz0304 good comments!

We can move the TOC to the right once the mkdocs tools are up and running. I will keep additional resources in my mind such that as we add documentation we can build such links.

Right now, this is the one document on the plugins.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants