docs2
docs2 copied to clipboard
o1-labs
DX - Improvement Request to show doc updated date
This is hopefully a pretty low effort, but I would love to see a Updated_at tag for the documentation.
- This helps me stay informed if a more comprehensive overview of documentation is now available.
- Some of the documentation has historically had TODOs, this updated_at tag would be a useful signal to go back to these sections and see if documentation now exists for certain concepts/use cases.
I like your suggestion @ckartik and recognize the value of your request.
Let me see how we can make substantial doc updates more visible. Can you provide some examples of where you see docs that are effectively using this tag in practice?
We have many upcoming doc updates to accomplish a more focused initiative for improving our docs.
It's hard to find comparisons, as SnarkyJS more rapidly changes its API than more mature platforms with stable documentation and releases.
You allude to a good point, how do we maximize the effectiveness of such a tag in practice? I'm not 100% certain on the solution here, but I think updated_at may be a useful start.
@ckartik I always like examples of seeing this type of updated_at done and done well. Keep your eyes open for how time stamps in docs help community members know when docs are updated.
Interesting to see this implementation with the latest contributor shout out (good to engage contributors) and then to be able to see all contributors for a page https://ethereum.org/en/developers/docs/ethereum-stack/
This implementation gives credit (not clickable) and last updated on date https://wiki.polygon.technology/docs/home/blockchain-basics/solidity
another example of update metadata in the page footer https://docs-v2.k8ssandra.io/quickstarts/developer/
example of update with validated and updated dates https://docs.digitalocean.com/products/functions/how-to/develop-functions/
