Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
ArmandPhilippot
left a comment
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Thanks Ema! I left a few suggestions mostly around:
- docs style, consistency with other experimental pages
- and some reorganization to make it easier to scan. For example I find the API block placement a bit annoying currently:
Also, I noticed you mentioned the AstroLoggerDestination but I don't think we document its exact shape at the moment. It would be helpful to have a "Types reference" section with the public types/types required to build a custom logger.
Then, when the feature becomes stable we only need to reorganize the contents, everything would already be here.
For example, the experimental Route caching has an API reference but we could also use the same format used in the other references (e.g. Renderer types).
ArmandPhilippot
added
add new content
I was hoping to get some suggestions on where to have it, and if it needs an header |
|
If there is only one useful type, a reference section might not be the best approach and we could reshape 
(we don't necessarily need to show Otherwise, a new section at the end might be easier to organize the content. Each section only describe what is available and we add links to the relevant types for advanced users. This remains easy to scan without having to scroll too much for those not interested in building their own logger. Something like: 
And we have precedents for both approaches, so the structure remains familiar to users. |
|
Hey @ArmandPhilippot , I added more information to the page. Let me know what you think |
ArmandPhilippot
left a comment
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Thanks for the updates, @ematipico !
I left a few suggestions, most of them try to shorten/simplify the wording or add links when we can. And one of them is pretty big: if we replace your list with sections, we can link to them directly when needed and this might be easier to scan.
Feel free to disagree. 😄 After that, it looks ready to me!
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
ArmandPhilippot
left a comment
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Thanks Ema, this looks ready to me! 🫡
yanthomasdev
left a comment
yanthomasdev
left a comment
There was a problem hiding this comment.
Great work @ematipico, I have a few typo/nit and grammar suggestions and it should be good to go after applied! 🙌
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
4 participants
Description (required)
This PR adds documentation for the upcoming experimental logger. The RFC is here: withastro/roadmap#1339
Linear: AST-84
For Astro version:
6.2.0. See astro PR #16437.The attached PR is the one that mostly documents the new APIs