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

feat: install Typedoc & class diagram library #92

Merged
merged 5 commits into from
Oct 24, 2024
Merged

Conversation

zz-hh-aa
Copy link
Collaborator

@zz-hh-aa zz-hh-aa commented Sep 20, 2024

What does this PR do?

  • Installs typedoc and tsuml2 as dev dependencies
  • Creates scripts (both run through npm run docs) to generate docs folder with a UML SVG in
  • Adds the docs folder to the .gitignore

Why?

  • As decided in the dev call, typedoc-plugin-mermaid wouldn't suit our case since we wanted the diagrams to be generated automatically; and having some sort of auto-generated map would be useful.
    • This gives us a crude SVG at the moment but should be able to be customised further. I'd like to also add it straight to the Typedocs HTML output but haven't gotten there yet!

It may not be 100% ideal but hopefully it's useful for now?

class-map

Closes #121

Copy link

vercel bot commented Sep 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fairhold-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2024 1:08pm

@zz-hh-aa zz-hh-aa requested a review from a team September 20, 2024 11:35
@zz-hh-aa zz-hh-aa marked this pull request as draft October 4, 2024 08:34
Copy link

vercel bot commented Oct 4, 2024

@zz-hh-aa is attempting to deploy a commit to the Open Systems Lab's projects team on Vercel, but is not a member of this team. To resolve this issue, you can:

  • Make your repository public. Collaboration is free for open source and public repositories.
  • Upgrade to pro and add @zz-hh-aa as a member. A Pro subscription is required to access Vercel's collaborative features.
    • If you're the owner of the team, click here to upgrade and add @zz-hh-aa as a member.
    • If you're the user who initiated this build request, click here to request access.
    • If you're already a member of the Open Systems Lab's projects team, make sure that your Vercel account is connected to your GitHub account.

To read more about collaboration on Vercel, click here.

@zz-hh-aa zz-hh-aa changed the title feat: install Typedoc feat: install Typedoc & class diagram library Oct 4, 2024
@zz-hh-aa zz-hh-aa marked this pull request as ready for review October 4, 2024 13:54
@DafyddLlyr DafyddLlyr force-pushed the main branch 2 times, most recently from ae62f43 to bac99e6 Compare October 11, 2024 11:35
@gabrielegranello
Copy link
Collaborator

Great work @zz-hh-aa , looks good to me!

@zz-hh-aa zz-hh-aa merged commit ca4cce8 into main Oct 24, 2024
5 checks passed
@zz-hh-aa zz-hh-aa deleted the oz/class-mapping branch October 24, 2024 14:26
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.

Install a documentation library to generate diagrams of classes
2 participants