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: starter CHANGELOG for docs #871

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

feat: starter CHANGELOG for docs #871

wants to merge 3 commits into from

Conversation

barriebyron
Copy link
Contributor

@barriebyron barriebyron commented Feb 29, 2024

This PR starts (belatedly) a docs repo CHANGELOG

Target publish before the major upgrade, let's include the notable impactful changes that our users need to know about

Highlight especially the updates that require actions from our users.

Add entries with links to the docs that have updates our users will need to be successful with Berkeley

Links will work after docs are live

Why keep a changelog?

To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. Docs are not versioned, but with the major upgrade, let's be sure to let our users know where they can read about the high impact technical changes.

Who needs a changelog?

People do. The users of software are human beings who care about what's in the software. When the software changes, people want to know why and how.

@barriebyron barriebyron added the docs Improvements or additions to documentation label Feb 29, 2024
Copy link

vercel bot commented Feb 29, 2024

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

Name Status Preview Comments Updated (UTC)
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 5, 2024 1:32pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
07-oracles ⬜️ Ignored (Inspect) Visit Preview Mar 5, 2024 1:32pm

@barriebyron
Copy link
Contributor Author

@halsaphi @vfrsilva and MF friends, let's particularly list the technical docs that have changes that require action from our users

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

Successfully merging this pull request may close these issues.

1 participant