Skip to content

Update documentation#468

Merged
PoignardAzur merged 8 commits intolinebender:mainfrom
PoignardAzur:update_doc
Mar 3, 2024
Merged

Update documentation#468
PoignardAzur merged 8 commits intolinebender:mainfrom
PoignardAzur:update_doc

Conversation

@PoignardAzur
Copy link
Collaborator

Update README.md
Add ARCHITECTURE.md

@PoignardAzur
Copy link
Collaborator Author

PoignardAzur commented Feb 26, 2024

Rendered links:

@PoignardAzur
Copy link
Collaborator Author

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

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!

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

@PoignardAzur
Copy link
Collaborator 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
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.

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.

> - [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.

@DJMcNab DJMcNab requested a review from waywardmonkeys March 1, 2024 13:57
@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
Collaborator 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.

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
@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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants