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.

Sign up for GitHub

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

Jump to bottom

ROSES - Publish SDDs as part of the new website #3131

Closed
thomas-bc opened this issue Jan 14, 2025 · 0 comments · Fixed by #3139
Closed

ROSES - Publish SDDs as part of the new website #3131

thomas-bc opened this issue Jan 14, 2025 · 0 comments · Fixed by #3139
Assignees
@thomas-bc
Labels
ROSES Work funded by the ROSES proposal - see Discussions #3041

Comments

@thomas-bc
Copy link
Collaborator

thomas-bc commented Jan 14, 2025 •
edited by LeStarch
Loading

Description

As part of the ROSES work, we need a better handling of Software Design Documents (SDDs).
Right now they are published with Doxygen under the C++ API section. We should publish them under a different category on the fprime.jpl.nasa.gov, handled as Markdown files. This will allow much nicer rendering (e.g. mermaidJS etc.), and also for the content to be included in the search capability.

Deliverables

  • website changes

Related:
#3135
#3136
@thomas-bc thomas-bc added the ROSES Work funded by the ROSES proposal - see Discussions #3041 label Jan 14, 2025
@thomas-bc thomas-bc self-assigned this Jan 14, 2025
@LeStarch LeStarch mentioned this issue Jan 14, 2025
Open
10 tasks
@thomas-bc thomas-bc mentioned this issue Jan 15, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thomas-bc thomas-bc

Labels
ROSES Work funded by the ROSES proposal - see Discussions #3041
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add SDD aggregation into the core website thomas-bc/fprime
1 participant
@thomas-bc