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

Add a class diagram to the README #422

Closed
oliverklee opened this issue Feb 2, 2024 · 0 comments · Fixed by #482
Closed

Add a class diagram to the README #422

oliverklee opened this issue Feb 2, 2024 · 0 comments · Fixed by #482
Assignees
@oliverklee
Labels
documentation
Milestone
9.0.0: Drop suppo...

Comments

@oliverklee
Copy link
Contributor

oliverklee commented Feb 2, 2024 •
edited

We'll be able to use Mermaid for this:

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-mermaid-diagrams
https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/
https://mermaid.js.org/syntax/classDiagram.html
@oliverklee oliverklee self-assigned this Feb 17, 2024
oliverklee added a commit that referenced this issue Feb 17, 2024
@oliverklee
[DOCS] Add a class diagram
be7df2f 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

Due to a limitation of Mermaid, different things cannot share the
same name, and I had to add a `_` suffix to namespaces in order
to avoid collisions with class names.

Fixes #422
oliverklee added a commit that referenced this issue Feb 17, 2024
@oliverklee
[DOCS] Add a class diagram
e282370 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

Due to a limitation of Mermaid, different things cannot share the
same name, and I had to add a `_` suffix to namespaces in order
to avoid collisions with class names.

Fixes #422
@oliverklee oliverklee mentioned this issue Feb 17, 2024
Merged
oliverklee added a commit that referenced this issue Feb 17, 2024
@oliverklee
[DOCS] Add a class diagram
99c82c6 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

Due to a limitation of Mermaid, different things cannot share the
same name, and I had to add a `_` suffix to namespaces in order
to avoid collisions with class names.

Fixes #422
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
29b4f1f 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
2dbe37f 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
1b44f7d 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
a76b46e 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422

[ci skip]
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
b27d170 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422

[ci skip]
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
0aa1973 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422

[ci skip]
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
7ffbb84 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422

[ci skip]
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
d6e9c21 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422

[ci skip]
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
25e3c42 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422
oliverklee added a commit that referenced this issue Feb 24, 2024
@oliverklee
[DOCS] Add a class diagram
4029601 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422
oliverklee added a commit that referenced this issue Feb 26, 2024
@oliverklee
[DOCS] Add a class diagram (#482)
8f94950 
This diagram aims to provide an overview of which classes we have
and how their are interconnected. Hence, it does not contain
any methods or properties.

As the Mermaid render on GitHub does not support namespace, the
classes are not grouped into namespaces in the diagram.

Fixes #422
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@oliverklee oliverklee

Labels
documentation
Projects
None yet
Milestone
9.0.0: Drop support for PHP < 7.2 and...
Development

Successfully merging a pull request may close this issue.

[DOCS] Add a class diagram MyIntervals/PHP-CSS-Parser
1 participant
@oliverklee