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

Document and create diagrams to illustrate trait hierarchy #446

Open
ReeceHumphreys opened this issue Feb 9, 2023 · 4 comments
Open

Document and create diagrams to illustrate trait hierarchy #446

ReeceHumphreys opened this issue Feb 9, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@ReeceHumphreys
Copy link
Contributor

It seems that everyone is having a bit of a hard time keeping track of the relationships between many of our traits. It would be useful to update the readme with some explanations and mermaid diagrams.

@InsertCreativityHere
Copy link
Member

The documentation for this already exists, just not on the docs site, since it's only recently come into existence;
see https://zeroc.atlassian.net/wiki/spaces/~austin/pages/1100742723/Slice+Compiler+Traits

I think this would be beyond the scope of the README.

@InsertCreativityHere
Copy link
Member

And most importantly the UML diagram for them:
image

@InsertCreativityHere
Copy link
Member

Once I get the compiler to a shippable state (hopefully soon), I plan to migrate all my documentation for the compiler from Confluence to the new docs site. It just hasn't been a high priority for me.

@InsertCreativityHere
Copy link
Member

Also note that this diagram doesn't include the Member (for DataMember and Parameter) or Container traits.
Those are orthogonal to all the other traits, and self-explanatory enough I felt them not worth including in the diagram.

@pepone pepone added the documentation Improvements or additions to documentation label Apr 12, 2023
@pepone pepone added this to the 0.1 milestone Apr 12, 2023
@InsertCreativityHere InsertCreativityHere modified the milestones: 0.1, 0.2 Apr 19, 2023
@InsertCreativityHere InsertCreativityHere modified the milestones: 0.2, Future Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants