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

Include documentation diagrams #3

Open
toddhalfpenny opened this issue Jun 2, 2020 · 2 comments
Open

Include documentation diagrams #3

toddhalfpenny opened this issue Jun 2, 2020 · 2 comments

Comments

@toddhalfpenny
Copy link
Contributor

It would be great to have visual representations of the metadata included in the documentation.

I have been looking at a few options - initially for ERD-esq pics for the object groups - and have looked at go.js, joints.js, and plantuml among others, and have seen that each has its own pros/cons. Although it would be super-ace (IMO) to have interactive diagrams to allow you to expand each object to view information such as page layouts, picklist values etc, it seems that the JS libs for this have a higher barrier to entry (learning curve/$$$).

With this in mind I've started playing with plantuml (free, awesome, and raw format is good for versioning). It outputs png/svg and supports many diff diagram types. Here's an example of what I have it outputting this for the Event group. This is generated from the already parsed XML and kicks out an SVG (so it's searchable within the page).

Screenshot from 2020-06-02 20-35-59

Thoughts appreciated, and if a PR would be welcome, etc.

@keirbowden
Copy link
Owner

That looks really nice. I definitely think a free tool is the way to go even if that means it you can't click through to the details. A while back I played around with including static resources and just had them at the top of the page, so I don't think the lack of interactivity is a deal breaker.

@toddhalfpenny
Copy link
Contributor Author

Great stuff. Thanks for the feedback.
I was even thinking that seeing as plantuml can output into SVG, then perhaps (if it's in-lined) then perhaps it could even be interactive via JS.

I'll get coding :)

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

No branches or pull requests

2 participants