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

Update documentation #468

Merged
merged 8 commits into from
Mar 3, 2024
Merged

Update documentation #468

merged 8 commits into from
Mar 3, 2024

Conversation

PoignardAzur
Copy link
Contributor

Update README.md
Add ARCHITECTURE.md

@PoignardAzur
Copy link
Contributor Author

PoignardAzur commented Feb 26, 2024 •
edited
Loading

Rendered links:

@PoignardAzur
Copy link
Contributor Author

Uuuugh. Clippy thinks "PostScript" is a doc item.

DasLixou
DasLixou reviewed Feb 26, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
raphlinus
raphlinus approved these changes Feb 26, 2024
View reviewed changes
Copy link
Contributor

@raphlinus raphlinus left a comment

Choose a reason for hiding this comment

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

I did a medium-depth pass, and am publishing my review now so we can keep velocity. I might have more comments later. In any case, I think it's pretty solid overall and will be very helpful to people coming to the repo. Thanks!

ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
DJMcNab
DJMcNab reviewed Feb 27, 2024
View reviewed changes
Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

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

I've only skimmed through the architecture document, but it's good to get one added.

Otherwise, some parts of the readme which I think could be clarified further

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
zoechi
zoechi reviewed Feb 27, 2024
View reviewed changes
src/lib.rs Show resolved Hide resolved
waywardmonkeys
waywardmonkeys previously requested changes Feb 27, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@PoignardAzur
Copy link
Contributor Author

(Sorry everyone, I rebased from master and ended up doing a force push. My corrections from feedback are in the third commit.)

@PoignardAzur PoignardAzur marked this pull request as ready for review February 29, 2024 15:33
DasLixou
DasLixou reviewed Feb 29, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
xStrom
xStrom reviewed Feb 29, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
nicoburns
nicoburns reviewed Mar 1, 2024
View reviewed changes
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
raphlinus
raphlinus approved these changes Mar 1, 2024
View reviewed changes
Copy link
Contributor

@raphlinus raphlinus left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This looks good, much improved over previous drafts, thanks! Subject to addressing the other pending review comments, I think we're good to go for an 0.1 release, then of course we will continue to incrementally improve and refine things.

README.md
> - [Major rendering artifacts when drawing more than 64k objects](https://github.com/linebender/vello/issues/334).
> - [Implementing blur and filter effects](https://github.com/linebender/vello/issues/476).
> - [Properly implementing strokes](https://github.com/linebender/vello/issues/303) and [supporting all SVG stroke caps](https://github.com/linebender/vello/issues/280).
> - [Conflations artifacts](https://github.com/linebender/vello/issues/49).
Copy link
Contributor

Choose a reason for hiding this comment

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

I really should update this bug, as conflation artifacts within a path are fixed now, if you select multisampled rendering. Of course, conflation in compositing (a considerably harder problem) is still open.

README.md Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/scene.rs Outdated Show resolved Hide resolved
@xStrom xStrom mentioned this pull request Mar 1, 2024
Merged
xStrom
xStrom reviewed Mar 1, 2024
View reviewed changes
ARCHITECTURE.md Outdated Show resolved Hide resolved
@DJMcNab DJMcNab dismissed waywardmonkeys’s stale review March 1, 2024 13:58

Requested change was resolved

@DJMcNab DJMcNab removed the request for review from waywardmonkeys March 1, 2024 13:58
@PoignardAzur
Copy link
Contributor Author

I think everyone's feedback is addressed. Will merge this today unless there's some egregious problem. Any further tweaks will happen in a future PR.

xStrom
xStrom reviewed Mar 2, 2024
View reviewed changes
src/scene.rs Outdated Show resolved Hide resolved
xStrom
xStrom approved these changes Mar 2, 2024
View reviewed changes
Copy link
Member

@xStrom xStrom left a comment

Choose a reason for hiding this comment

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

Nice work, great to see the docs improving like this! 🚀

@PoignardAzur PoignardAzur added this pull request to the merge queue Mar 3, 2024
Merged via the queue into linebender:main with commit 9f6749d Mar 3, 2024
9 checks passed
@PoignardAzur PoignardAzur deleted the update_doc branch March 4, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DasLixou DasLixou DasLixou left review comments

@zoechi zoechi zoechi left review comments

@xorgy xorgy xorgy approved these changes

@nicoburns nicoburns nicoburns approved these changes

@xStrom xStrom xStrom approved these changes

@raphlinus raphlinus raphlinus approved these changes

@waywardmonkeys waywardmonkeys waywardmonkeys left review comments

@DJMcNab DJMcNab Awaiting requested review from DJMcNab

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@PoignardAzur @waywardmonkeys @raphlinus @zoechi @xStrom @nicoburns @xorgy @DJMcNab @DasLixou