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

docs/install/release-notes: add index.mdx #277

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

AlternateRT
Copy link
Contributor

This PR adds a page at https://ghostty.org/docs/install/release-notes to index all current and future releases.

This is done to partially complete ghostty-org/ghostty#4730.

Copy link

vercel bot commented Jan 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 1:13pm

@BrandonRomano BrandonRomano added the docs Related to documentation label Jan 22, 2025
@mitchellh mitchellh merged commit dad9bdf into ghostty-org:main Jan 24, 2025
2 checks passed
@AlternateRT AlternateRT deleted the release-notes-index branch January 27, 2025 08:44
mitchellh added a commit to ghostty-org/ghostty that referenced this pull request Jan 29, 2025
Resolves #4730

I opted to link directly to the release notes of the updated version in
the `<description>` body, i.e. in the future it would link directly
v1.0.2's release notes at
https://ghostty.org/docs/install/release-notes/1-0-2. This thereby
implements the second option mentioned in the issue. It wasn't that much
harder than the third option, but if there's any particular reason _not
to_ link directly to a version's changelog page, I'll be more than happy
to modify this PR and implement the third option instead - in any case,
I had opened ghostty-org/website#277 so that
https://ghostty.org/docs/install/release-notes is a valid page.

I also wrapped the current text `<![CDATA[ ... ]]>` just in case, as I
noticed this is a pretty standard practice in other apps that use
`<description>` to embed their release notes when using Sparkle -
[Sparkle's
documentation](https://sparkle-project.org/documentation/publishing/#embedded-release-notes)
says to do this so you can use unescaped HTML.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants