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

702.document snapshots #710

Merged
merged 10 commits into from May 19, 2023
Merged

Conversation

meejah
Copy link
Collaborator

@meejah meejah commented Mar 17, 2023

Fixes #702

@codecov
Copy link

codecov bot commented Mar 17, 2023

Codecov Report

Merging #710 (5e6883f) into main (a68f9c7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #710   +/-   ##
=======================================
  Coverage   91.79%   91.79%           
=======================================
  Files          38       38           
  Lines        5144     5144           
  Branches      640      640           
=======================================
  Hits         4722     4722           
  Misses        277      277           
  Partials      145      145           
Flag Coverage Δ
integration 72.97% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@meejah
Copy link
Collaborator Author

meejah commented Mar 17, 2023

Note to self: the metadata entries in the Collective and Personal should be @metadata instead (e.g. in all the diagrams).

@meejah
Copy link
Collaborator Author

meejah commented Mar 19, 2023

Besides the above tweak needed for the diagrams, I think this is ready for some Opinions if you have any @exarkun (you can see a rendered version of this branch by clicking through the "read the docs" check).

@meejah
Copy link
Collaborator Author

meejah commented May 19, 2023

I tried ensuring all the SVGs are "plain" (not "Inkscape") SVGs but github / firefox is still rendering the arrows w/o heads.

That's the only gnit though; I'm going to merge this -- please file followup tickets if anything is missing or unclear :)

@meejah meejah merged commit c363f22 into tahoe-lafs:main May 19, 2023
13 checks passed
@meejah meejah deleted the 702.document-snapshots branch May 19, 2023 02:42
Comment on lines +70 to +71
:width: 100%
:height: 30pt

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this on purpose? 30pt ~= 10,6 mm.

ReadTheDocs seems to only interpret the width (of 100%), the GitHub rendering only interprets the height (30pt, tiny).
Both keep the original aspect ratio - which is good - probably because one of width/height is a percentage?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(On my end, a height of 300pt looks good in GitHub)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Document the "snapshot" format
2 participants