Tip 23 - is not was
Life is a journey, not a destination. Your docs readers, however, are not along for the ride.
Just as you don’t need to narrate the progression through the page, you can also cut the “life story” of your docs.
One PR suggestion I often make is to document your features, not how or why they came to be.
-
✅ To add support for formatting
.astrofiles, use the official Astro Prettier plugin. -
😐 To add Astro support (
.astrofiles), we created and maintain an official Prettier Astro plugin.
When you remove the story of what you did, the focus naturally shifts to what your reader should do… which is what they really came to docs for in the first place!
Toggle Comments
© 2021 - 2024 Sarah Rainsberger. Except where otherwise noted, and/or quoting external sources, the content of this site is licensed under CC BY-NC-SA 4.0 
