lit / lit/lit.dev

Add release notes to docs site

Open
#651 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
142
Forks
230
PR merge metrics
No merged PRs in 30d

Description

## Description
- For consistency with lit-html docs.

## Acceptance criteria
- Individual pages per-release (for example, /guide/release-notes/2.4.0.html)
- Summary page collecting all release notes. (for example, /guides/release-notes.html) release
- Only document releases going forward; for older releases, we can point to the changelog.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing docs site structure and comparing it with the lit-html docs. Check the changelog to identify releases that should be excluded, then determine how release-note pages and a summary page fit into the site. Done means forward releases have individual pages, the summary collects them, and older releases link to the changelog.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.