Skip to content

Rewrite README.md to make clear that all code is archived - #2770

Merged
sulco merged 1 commit into
archivefrom
fvsch/update-readme-archive
Oct 9, 2023
Merged

Rewrite README.md to make clear that all code is archived#2770
sulco merged 1 commit into
archivefrom
fvsch/update-readme-archive

Conversation

@fvsch

@fvsch fvsch commented Oct 9, 2023

Copy link
Copy Markdown
Contributor

ℹ️ This PR targets the archive branch, not the main branch.

This PR is part of a small project to make the stackblitz/core repository more user-friendly and a better reflection of StackBlitz products and technology.

One part of this project is removing legacy code this is not used anymore and does not meaningfully represent the current feature set and capabilities of StackBlitz and its SDK and APIs.

But instead of removing it wholesale, we probably want to archive this code and keep it around for historical reasons. It would stay in Git history, but it’s probably better to have a place to point people to if they want to check it out.

My plan for having this “place to point people to”:

  1. Make a new archive branch that duplicates main and contains all legacy code. (Done.)
  2. Update its README.md to call out that code in this repository is legacy/archived. (This PR.)
@fvsch
fvsch requested a review from sulco October 9, 2023 11:29
@fvsch
fvsch changed the base branch from main to archive October 9, 2023 11:29
@sulco
sulco merged commit 08776f1 into archive Oct 9, 2023
@fvsch
fvsch deleted the fvsch/update-readme-archive branch October 10, 2023 13:34

@cs-adakami cs-adakami left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cs-adakami cs-adakami left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cs-adakami

Copy link
Copy Markdown

ℹ️ This PR targets the archive branch, not the main branch.

This PR is part of a small project to make the stackblitz/core repository more user-friendly and a better reflection of StackBlitz products and technology.

One part of this project is removing legacy code this is not used anymore and does not meaningfully represent the current feature set and capabilities of StackBlitz and its SDK and APIs.

But instead of removing it wholesale, we probably want to archive this code and keep it around for historical reasons. It would stay in Git history, but it’s probably better to have a place to point people to if they want to check it out.

My plan for having this “place to point people to”:

  1. Make a new archive branch that duplicates main and contains all legacy code. (Done.)
  2. Update its README.md to call out that code in this repository is legacy/archived. (This PR.)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants