-
Notifications
You must be signed in to change notification settings - Fork 0
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
docs: create overview of repos and websites for all of seedcase #152
base: main
Are you sure you want to change the base?
Conversation
@K-Beicher as we talked about at the update meeting, I think the |
Thank you for the reminder @signekb. Theme has now been added, the whole thing now looks like this, I'm not happy with the arrow from About to About. |
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.
Very nice! I think this is a nice overview of what we have so far. I have added a lot of casing suggestions and a comment referring to @lwjohnst86's comment during today's meeting (29/05/2024) that it might be a nice alternative to do this in Mermaid instead to include clickable links instead of writing them as text here.
entries/repo-website-overview.puml
Outdated
} | ||
|
||
package community as COM { | ||
object "Community.Seedcase-Project.org" as CSP { |
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.
As Luke mentioned on the meeting, it might be an idea to use Mermaid as done in the SDCA research-ops repo here so we can add a link directly to the websites instead of writing the url?
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.
@lwjohnst86 Thoughts? Should the puml be changed to mermaid?
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.
Yes please! Mermaid is easier to use to incorporate clickable links.
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.
The re-write in Mermaid will have to wait until after my summer holiday, do you guys want to merge this in, and then I can create an issue on converting it to Mermaid, or should I move this back into draft to make it go away from my lists?
minor style changes Co-authored-by: Signe Kirk Brødbæk <[email protected]>
@K-Beicher If you can't finish this yet and want to come back to it, move it over to in progress. Best not to merge things that have requested changes unless there is a time critical reason |
Description
Related Issues
Closes seedcase-project/community#12
Reviewer Focus
This PR requires an in-depth review.
We need to look at whether this is a useful direction to go in with regards to creating an overview of our project. Or if there is a better way to keep track of our repos and websites.
Repos are denoted with 'folders' websites as documents within. Diamonds indicate that there is no website associated with the repo.
Checklist
For general documentation: