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

Commit 2218ac8

Browse files
committed
docs: clean up README formatting and improve 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.
1 parent 7581d40 commit 2218ac8

2 files changed

Lines changed: 11 additions & 12 deletions

File tree

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@ Then you can set breakpoints directly to the typescript files and the debugger w
9494

9595
![Debugging](/.github/assets/breakpoints.png)
9696

97-
9897
## Community
9998

10099
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
@@ -112,9 +111,9 @@ For bugs or feature requests, please [submit an issue](https://github.com/storyb
112111
> [!IMPORTANT]
113112
> 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).
114113
115-
### I can't share my company project code
114+
### I can't share my company project code
116115

117-
We understand that you might not be able to share your company's project code. Please provide a minimal reproducible example that demonstrates the issue by using tools like [Stackblitz](https://stackblitz.com) or a link to a Github Repo lease make sure you include a README file with the instructions to build and run the project, important not to include any access token, password or personal information of any kind.
116+
We understand that you might not be able to share your company's project code. Please provide a minimal reproducible example that demonstrates the issue by using tools like [Stackblitz](https://stackblitz.com) or a link to a Github Repo lease make sure you include a README file with the instructions to build and run the project, important not to include any access token, password or personal information of any kind.
118117

119118
### I only have a question
120119

src/commands/types/generate/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,14 @@ typesCommand
5757
});
5858

5959
// 2. Operations Layer (actions.ts)
60-
- generateTypes()
61-
- generateStoryblokTypes()
62-
- saveTypesToFile()
60+
-generateTypes()
61+
- generateStoryblokTypes()
62+
- saveTypesToFile()
6363

6464
// 3. Actions Layer (actions.ts)
65-
- getComponentType()
66-
- getComponentPropertiesTypeAnnotations()
67-
- sanitizeComponentName()
65+
- getComponentType()
66+
- getComponentPropertiesTypeAnnotations()
67+
- sanitizeComponentName();
6868
```
6969

7070
### Processing Flow Examples
@@ -179,12 +179,12 @@ Flow:
179179
for (const component of spaceData.components) {
180180
const componentType = getComponentType(component.name, options);
181181
const properties = getComponentPropertiesTypeAnnotations(component.schema, options);
182-
182+
183183
// 2. Create a separate file for each component
184184
const fileContent = `export interface ${componentType} {
185185
${properties}
186186
}`;
187-
187+
188188
// 3. Save to a separate file
189189
await saveToFile(`${component.name}.d.ts`, fileContent);
190190
}
@@ -317,4 +317,4 @@ The command includes comprehensive test coverage:
317317
**Error Handling**
318318
- [ ] It should throw an error if the space is not provided: "Please provide the space as argument --space YOUR_SPACE_ID."
319319
- [ ] It should handle errors during type generation gracefully
320-
- [ ] It should provide meaningful error messages for common issues
320+
- [ ] It should provide meaningful error messages for common issues

0 commit comments

Comments
 (0)