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

Import wiki from original Darglint #39

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Import wiki from original Darglint #39

wants to merge 4 commits into from

Conversation

akaihola
Copy link
Owner

@akaihola akaihola commented May 28, 2023

Fixes #3 partially.

Bringing in the Wiki documents and images from the Design section of the original Darglint wiki.

To do:

  • move the documents to the docs/ folder
  • build Graphviz images into PNG SVG as part of documentation build
  • decide whether to include those PNG SVG images in the repository or to host them from somewhere else
  • implement decided storage for the PNG SVG images

@akaihola akaihola added the documentation Improvements or additions to documentation label May 28, 2023
@akaihola akaihola added this to the 1.9.0 – feature release milestone May 28, 2023
@akaihola akaihola requested a review from real-yfprojects May 28, 2023 17:33
@akaihola akaihola self-assigned this May 28, 2023
@real-yfprojects
Copy link
Collaborator

  • decide whether to include those PNG images in the repository or to host them from somewhere else

I would also consider rendering to an SVG. Regarding storage I think the repository will be the best place for that since this ensures the images are present while external storage options might go offline at some point (if neglected).

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
Status: No status
Development

Successfully merging this pull request may close these issues.

Document tidbits from original author
3 participants