-
Notifications
You must be signed in to change notification settings - Fork 27
Add first crude documentation for Inline-layout and font-matching #68
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
base: main
Are you sure you want to change the base?
Add first crude documentation for Inline-layout and font-matching #68
Conversation
Layout and font matching. Signed-off-by: Desiatkin Dmitrii <[email protected]>
96c6ec4
to
da34f4b
Compare
Signed-off-by: Desiatkin Dmitrii <[email protected]>
information. Signed-off-by: Desiatkin Dmitrii <[email protected]>
299d5f4
to
d9378df
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for writing these new chapters, it’s clear you’ve put a lot of work into not only understanding fonts and inline layout, but also sharing that knowledge for the benefit of all contributors.
I’ve left some comments and questions inline. Unfortunately it will need a lot of work before it can be landed in the book. The new text seems to be a lot more personal and “play-by-play” than the rest of the book, which is well-suited to a blog post, but maybe not the most effective structure for Servo’s long-term docs.
More importantly, I’m not very experienced with our fonts and inline layout subsystems. I can help with copyediting, but first I will ask some of my colleagues to check the technical content.
One question though, in the Fonts chapter, did you write the Interesting Facts and Digital Font Representation sections yourself, or did you use any AI tools? I ask because it seems to be written in a very different style to the rest of your patch, and while interesting, the Servo book is not the best place for this information.
|
||
## QA | ||
If you have any question you may find answers [on Zulip](https://servo.zulipchat.com). | ||
@**Delan Azabani** is the original author of the book. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any reason to name me specifically? if it’s for reviews, i’ve added a CODEOWNERS file that will automatically add me to pull requests as a reviewer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I decided to add contacts of authors of original modules to servo book not only for reviews. I did it so newcomers may easily find person who can answer their question on Zulip. Right now they will login to common chat and create a topic on each question. Usually newcomers questions are quite similar, so I though that it would be better if they can hop right into direct messages to authors and maintainers of particular module. In that way you can create new topics only on really important questions.
I understand that this might be quite stressful, so it is entirely your decision whether your contact should be present here. I believe I also leaved Martin Robinson contact on one of the pages.
Please inform me on your decision regarding this question
2c86b65
to
037d18c
Compare
Expand documentation in several points of inline layout. Add contributing to the servo-book section Signed-off-by: Desiatkin Dmitrii <[email protected]>
mermaid-init.js is a custom version written for Servo. My previous auto update change must be reverted Co-authored-by: delan azabani <[email protected]> Signed-off-by: Dmitrii Desiatkin <[email protected]>
… to main Readme.md
…d by VSCode extension
…ction. Leave only the links
…rchive link. Also I added great writeups on font technologies stack
…be added in separate patch
d3c051d
to
9cfc29d
Compare
First of all Thank you for review!
I can see it myself an wait for any suggestions and improvements that you or other community members may provide.
Regarding this question. I write section myself and later I asked AI to fix writing in that particular small section. Also some minor rephrases in shaping section was done with use of it. I understand that LLM's and models is currently prohibited by code of conduct, but I want to open and participate in discussion regarding their use as editor tools. Important remark I have not provided any servo code in my prompt. I just copy pasted text that was written by me and ask AI agent to fix style and grammar. Concerning the applicability of such information to servo book. I added this section cause it contains some technologies that would be really nice addition to servo. I.e SDF / MSDF fonts, they allow to make scaling of font characters really efficient and moreover it maintain quality. How do you think should servo have a page with technologies that would be a nice addition but obviously would not be in official roadmap because of their low priority. I think we can add such page for community |
That sounds better suited to an issue in the issue tracker than the project documentation. |
documentation: Add first crude documentation for Inline Layout and font matching.
This PR related to the following issues: