undocs
undocs copied to clipboard
feat: add changelog page
๐ Linked issue
#32
โ Type of change
- [ ] ๐ Documentation (updates to the documentation, readme, or JSdoc annotations)
- [ ] ๐ Bug fix (a non-breaking change that fixes an issue)
- [ ] ๐ Enhancement (improving an existing functionality like performance)
- [X] โจ New feature (a non-breaking change that adds functionality)
- [ ] ๐งน Chore (updates to the build process or auxiliary tools and libraries)
- [ ] โ ๏ธ Breaking change (fix or feature that would cause existing functionality to change)
๐ Description
Currently can be accessed:
https://feat-changelogs.undocs.pages.dev/changelog
TODO
- [ ] OG Image
- [ ] Put link within header?
Resolves: #32
๐ Checklist
- [X] I have linked an issue or discussion.
- [ ] I have updated the documentation accordingly.
Deploying undocs with ย
ย Cloudflare Pages
| Latest commit: |
e68493f
|
| Status: | ย โ ย Deploy successful! |
| Preview URL: | https://af125f82.undocs.pages.dev |
| Branch Preview URL: | https://feat-changelogs.undocs.pages.dev |
@pi0 I'm not for sure what we want the OG Image to look like but here is a quick take at it:
Probably no or with less advertising title. It is simply a changelog page.
I do find it quite cool personally, it's not too much IMO ๐
(i still prefer a shorter/no description as such -- also it is not "what is happening"!, but respect you might have different marketing goals when we generalize undocs to add something like this in the future)
Updates:
- Using
OGImageDocstemplate for now - Changed
changelogs->changelog - Added
Changelogto CMD+K command pallet - Better optimized for mobile phones
i expect og description to be removed still.
i expect og description to be removed still.
I removed the OG Image description.
Shall we maybe find a way to reduce the gap when there are not a lot of updates?
See https://feat-changelogs.undocs.pages.dev/changelog
Also, see lower down the page:
(moving back to draft status. i like to make some changes to make sure it works stably for adoption)
@pi0 the only problem with using ungh was the caching, if you were to release it wouldn't update until the cache is busted. Unless we can force reload on new versions passing in a param to url.
Just an fyi. I am not for sure if we can add anything so the page can be updated with the releases of github.
Yes. I am thinking to rely on CHANGELOG.md instead also we need to render a normal multi section page because generated release notes can have more variable contents (see temporary fixed value for unjs/nitro)