undocs icon indicating copy to clipboard operation
undocs copied to clipboard

feat: add changelog page

Open cpreston321 opened this issue 1 year ago โ€ข 13 comments

๐Ÿ”— 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.

cpreston321 avatar Mar 04 '24 19:03 cpreston321

Deploying undocs with ย Cloudflare Pages ย Cloudflare Pages

Latest commit: e68493f
Status:ย โœ…ย  Deploy successful!
Preview URL: https://af125f82.undocs.pages.dev
Branch Preview URL: https://feat-changelogs.undocs.pages.dev

View logs

@pi0 I'm not for sure what we want the OG Image to look like but here is a quick take at it: CleanShot 2024-03-05 at 11 13 25@2x

cpreston321 avatar Mar 05 '24 16:03 cpreston321

Probably no or with less advertising title. It is simply a changelog page.

pi0 avatar Mar 05 '24 16:03 pi0

I do find it quite cool personally, it's not too much IMO ๐Ÿ˜Š

atinux avatar Mar 05 '24 17:03 atinux

(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)

pi0 avatar Mar 05 '24 17:03 pi0

Updates:

  • Using OGImageDocs template for now
  • Changed changelogs -> changelog
  • Added Changelog to CMD+K command pallet
  • Better optimized for mobile phones

CleanShot 2024-03-05 at 12 41 36@2x

cpreston321 avatar Mar 05 '24 17:03 cpreston321

i expect og description to be removed still.

pi0 avatar Mar 05 '24 17:03 pi0

i expect og description to be removed still.

I removed the OG Image description.

cpreston321 avatar Mar 05 '24 17:03 cpreston321

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

atinux avatar Mar 19 '24 09:03 atinux

Also, see lower down the page:

CleanShot 2024-03-19 at 10 12 25@2x

danielroe avatar Mar 19 '24 10:03 danielroe

(moving back to draft status. i like to make some changes to make sure it works stably for adoption)

pi0 avatar Mar 19 '24 11:03 pi0

@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.

cpreston321 avatar Sep 04 '24 18:09 cpreston321

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)

pi0 avatar Sep 04 '24 18:09 pi0