Skip to content
This repository was archived by the owner on Jan 19, 2026. It is now read-only.

Commit fc936d2

Browse files
committed
docs: update README for clarity and accuracy
- Improved image alt text for better accessibility in the debugging section. - Corrected issue submission link to point to the Storyblok CLI repository. - Updated contribution documentation link to reflect the correct repository.
1 parent 6c914ad commit fc936d2

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,11 @@ pnpm run coverage
8989

9090
To debug the CLI you can use the `launch.json` configuration in the `.vscode` folder. You can run any command with the debugger attached.
9191

92-
![Debugging](/.github/assets/debug-vscode.png)
92+
![A screenshot of the Visual Studio Code debugger](/.github/assets/debug-vscode.png)
9393

9494
Then you can set breakpoints directly to the typescript files and the debugger will handle the rest with sourcempaps.
9595

96-
![Debugging](/.github/assets/breakpoints.png)
96+
![A screenshot of a breakpoint set in the Visual Studio Code debugger](/.github/assets/breakpoints.png)
9797

9898
## Community
9999

@@ -107,7 +107,7 @@ For community support, chatting with other users, please visit:
107107

108108
## Support
109109

110-
For bugs or feature requests, please [submit an issue](https://github.com/storyblok/my-joyful-package/issues/new/choose).
110+
For bugs or feature requests, please [submit an issue](https://github.com/storyblok/storyblok-cli/issues/new/choose).
111111

112112
> [!IMPORTANT]
113113
> Please search existing issues before submitting a new one. Issues without a minimal reproducible example will be closed. [Why reproductions are Required](https://antfu.me/posts/why-reproductions-are-required).
@@ -122,7 +122,7 @@ If you have a question, please ask in the [Discuss Storyblok on Discord](https:/
122122

123123
## Contributing
124124

125-
If you're interested in contributing to my-joyful-package, please read our [contributing docs](https://github.com/storyblok/.github/blob/main/CONTRIBUTING.md) before submitting a pull request.
125+
If you're interested in contributing to Storyblok CLI, please read our [contributing docs](https://github.com/storyblok/.github/blob/main/contributing.md) before submitting a pull request.
126126

127127
## License
128128

src/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ npm install storyblok@4.0.0-beta.<version>
5656
5757
If you wish to continue using the `sync` command, please refer to the [v3](https://github.com/storyblok/storyblok-cli/tree/v3?tab=readme-ov-file#sync) documentation and use `storyblok@v3.36.1` or previous.
5858

59-
6059
## Global Options
6160

6261
These options are available for all commands:

0 commit comments

Comments
 (0)