Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add changelog page #91

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

feat: add changelog page #91

wants to merge 9 commits into from

Conversation

cpreston321
Copy link
Member

@cpreston321 cpreston321 commented Mar 4, 2024

πŸ”— 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)
  • ✨ 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

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Copy link

cloudflare-workers-and-pages bot commented Mar 4, 2024

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

app/pages/changelogs.vue Outdated Show resolved Hide resolved
@cpreston321
Copy link
Member Author

@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

@pi0
Copy link
Member

pi0 commented Mar 5, 2024

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

@atinux
Copy link
Member

atinux commented Mar 5, 2024

I do find it quite cool personally, it's not too much IMO 😊

@pi0
Copy link
Member

pi0 commented Mar 5, 2024

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

@cpreston321
Copy link
Member Author

cpreston321 commented Mar 5, 2024

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 cpreston321 changed the title feat: changelogs page feat: add changelog Mar 5, 2024
@pi0
Copy link
Member

pi0 commented Mar 5, 2024

i expect og description to be removed still.

@pi0 pi0 changed the title feat: add changelog feat: add changelog page Mar 5, 2024
@cpreston321
Copy link
Member Author

i expect og description to be removed still.

I removed the OG Image description.

@cpreston321 cpreston321 marked this pull request as ready for review March 18, 2024 17:33
@atinux
Copy link
Member

atinux commented Mar 19, 2024

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

@danielroe
Copy link
Member

Also, see lower down the page:

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

@pi0
Copy link
Member

pi0 commented Mar 19, 2024

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

@pi0 pi0 marked this pull request as draft March 19, 2024 11:02
@cpreston321
Copy link
Member Author

cpreston321 commented Sep 4, 2024

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

@pi0
Copy link
Member

pi0 commented Sep 4, 2024

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add releases page that leverages ungh
4 participants