Documentation: Denote newly updated sections #12385
leggomuhgreggo
started this conversation in
Feature Requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Firstly congrats to the Nx on the docs site design refresh!
Good docs ain't easy and the Nx folks do a wonderful job. Incredible progress compared to a couple years ago.
I wanted to suggest a some docs related feature wish list items mainly just so they're on peoples radar -- which they may well be already!
Feature Description
Motivation
TL;DR: The goal is to help people stay up to date + provide a higher-level of integration between the VCS progression + the docs.
Possible Approaches
New Feature Marker
Here's an example from XState's docs where they added a version tag to the new feature's documentation
Scoped Changelog
Another possible option would be to have "scoped changelogs" one of my favorite examples of this is with Braid Design System which has release notes that are specific to each component.
Changed Since?
I mean at a certain point we reach a docs oriented IDE, but in a dream world this would obviously be marvelous -- and even if it's unrealistic for a feature request -- technologically speaking the ingredients are there.
Simple Highlights Reel
Even just periodically highlighting updates to specific pages/feature on social is a huge help.
Wrapping Up
Y'all are already rockin the visibility / outreach action. And I appreciate it, frealz
Thanks!
Beta Was this translation helpful? Give feedback.
All reactions