This repository was archived by the owner on Jan 19, 2026. It is now read-only.
chore: readme based on new template#183
Merged
Merged
Conversation
- Enhanced the README with a new section on features, improving clarity on the capabilities of the Storyblok CLI. - Added a comprehensive documentation file for the Type Generation Command, detailing prerequisites, usage examples, architecture, and testing strategies to ensure type safety in Storyblok components. - Improved visual elements in the README, including badge colors and layout adjustments for better readability.
- Removed unnecessary blank lines and adjusted formatting in the main README and the Type Generation Command documentation to enhance clarity and consistency. - Ensured proper alignment of bullet points for better visual presentation.
edodusi
reviewed
May 5, 2025
edodusi
reviewed
May 5, 2025
|
|
||
| Before generating types, ensure you have: | ||
|
|
||
| - Access to the target Storyblok space |
Contributor
There was a problem hiding this comment.
Suggested change
| - Access to the target Storyblok space | |
| - A Storyblok account and an active login on the CLI |
edodusi
reviewed
May 5, 2025
edodusi
reviewed
May 5, 2025
| - Access to the target Storyblok space | ||
| - A Storyblok account with appropriate permissions | ||
| - TypeScript installed in your project (if you plan to use the generated types) | ||
| - Pull components from the target space using the `storyblok components pull` command |
Contributor
There was a problem hiding this comment.
Suggested change
| - Pull components from the target space using the `storyblok components pull` command | |
| - Components from the target space pulled using the `storyblok components pull` command |
Contributor
Author
There was a problem hiding this comment.
Hi @edodusi ignore the internal Readme, is gonna be removed anyways, the changes in this PR where barely linter based, the important one is the README.md in the core
Co-authored-by: Edoardo Dusi <edo@edoardodusi.com>
Co-authored-by: Edoardo Dusi <edo@edoardodusi.com>
commit: |
- Removed unnecessary hyphen from the `generateTypes()` function reference to ensure consistency in formatting. - This change improves the clarity of the documentation for users referencing the Type Generation Command.
edodusi
approved these changes
May 5, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a new README.md based on the company OSS Readme template