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.

Sign up for GitHub

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

Jump to bottom

Add information about the new config structure to README.md #89

Open
daniilsapa opened this issue Aug 21, 2024 · 2 comments · May be fixed by #96
Open

Add information about the new config structure to README.md #89

daniilsapa opened this issue Aug 21, 2024 · 2 comments · May be fixed by #96
Assignees
@daniilsapa
Labels
PRIORITY | LOW Can wait until after release TYPE | documentation Improvements or additions to documentation

Comments

@daniilsapa
Copy link
Collaborator

daniilsapa commented Aug 21, 2024 •
edited
Loading

  • Description of the new config format
  • How to use the new config
  • A short guide to migration to the new config

The migration guide should contain commands to perform migration for the major package managers:

  • npm
  • yarn
  • pnpm
@daniilsapa daniilsapa changed the title Add a migration guide to README.md Add information about the new config structure to README.md Aug 21, 2024
@daniilsapa
Copy link
Collaborator Author

@illright
Could you assign this one to me?

@illright
Copy link
Member

Sure. One comment before you start — I would prefer to keep migration instructions in a separate MIGRATION_GUIDE.md rather than the README, and the README could simply link there.

@daniilsapa daniilsapa linked a pull request Sep 2, 2024 that will close this issue
Open
@illright illright added TYPE | documentation Improvements or additions to documentation PRIORITY | LOW Can wait until after release labels Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@daniilsapa daniilsapa

Labels
PRIORITY | LOW Can wait until after release TYPE | documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

New config structure docs daniilsapa/steiger
2 participants
@illright @daniilsapa