Update README with warning message #19
Open
Conversation
This file contains 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
Add a warning message that this project is unfinished.
|
Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖 Please select which version do you want to release:
And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.
|
|
Beep boop 🤖 Thank you so much for keeping our documentation up-to-date ❤️ |
guerreirobeatriz
suggested changes
Dec 7, 2020
docs/README.md
Outdated
|
|
||
| ## Customization | ||
|
|
||
| The first thing that should be present in this section is the sentence below, showing users the recipe pertaining to CSS customization in blocks: | ||
| The first thing that should be present in this section is the sentence below, showing users the recipe pertaining to CSS customization in apps: |
There was a problem hiding this comment.
This is an instruction to add customization info to the doc! If no Handles are currently available, this part should be removed - only keep the No CSS Handles are available yet for the app customization.
docs/README.md
Outdated
Comment on lines
75
to
80
| `In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).` | ||
|
|
||
| Thereafter, you should add a single column table with the available CSS handles for that block: | ||
| Thereafter, you should add a single column table with the available CSS handles for the app, like the one below. Note that the Handles must be ordered alphabetically. | ||
|
|
||
| | CSS Handles | | ||
| | ----------- | |
There was a problem hiding this comment.
This is an instruction to add customization info to the doc! If no Handles are currently available, this part should be removed - only keep the No CSS Handles are available yet for the app customization.
docs/README.md
Outdated
Comment on lines
13
to
15
| Under the app's name, you should explain the topic, giving a **brief description** of its **functionality** in a store when installed. | ||
|
|
||
| Next, **add media** (either an image of a GIF) with the rendered components, so that users can better understand how the app works in practice. |
There was a problem hiding this comment.
This is an instruction to clarify which info should be added to the doc - It should be replaced with real data!
docs/README.md
Outdated
Comment on lines
21
to
63
| In this section, you first must **add the primary instructions** that will allow users to use the app's blocks in their store, such as: | ||
|
|
||
| 1. Adding the app as a theme dependency in the `manifest.json` file; | ||
| 2. Declaring the app's main block in a given theme template or inside another block from the theme. | ||
|
|
||
| Remember to add a table with all blocks exported by the app and their descriptions. You can verify an example of it on the [Search Result documentation](https://vtex.io/docs/components/all/[email protected]/). | ||
|
|
||
| Next, add the **props table** containing your block's props. | ||
|
|
||
| If the app exports more than one block, create several tables - one for each block. For example: | ||
|
|
||
| ### `block-1` props | ||
|
|
||
| | Prop name | Type | Description | Default value | | ||
| | ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | ||
| | `XXXXX` | `XXXXXX` | XXXXXXXX | `XXXXXX` | | ||
|
|
||
|
|
||
| ### `block-2` props | ||
|
|
||
| | Prop name | Type | Description | Default value | | ||
| | ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | ||
| | `XXXXX` | `XXXXXX` | XXXXXXXX | `XXXXXX` | | ||
|
|
||
| Prop types are: | ||
|
|
||
| - `string` | ||
| - `enum` | ||
| - `number` | ||
| - `boolean` | ||
| - `object` | ||
| - `array` | ||
|
|
||
| Next, add the **block's props table**: | ||
| When documenting a prop whose type is `object` or `array` another prop table will be needed. You can create it following the example below: | ||
|
|
||
| - `propName` object: | ||
|
|
||
| | Prop name | Type | Description | Default value | | ||
| | ------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | ||
| | `XXXXX` | `XXXXXX` | XXXXXXXX | `XXXXXX` | | ||
|
|
||
|
|
||
| Remember to also **showcase any necessary disclaimer** related to the block in this section, such as the different behavior it may display during its configuration. | ||
| Remember to also use this Configuration section to **showcase any necessary disclaimer** related to the app and its blocks, such as the different behavior it may display during its configuration. |
There was a problem hiding this comment.
This is an instruction to clarify which info should be added to the doc - It should be replaced with real data!
docs/README.md
Outdated
| Next, **add media** (either an image of a GIF) with the rendered block, so that users can better understand how the block works in practice. | ||
| Under the app's name, you should explain the topic, giving a **brief description** of its **functionality** in a store when installed. | ||
|
|
||
| Next, **add media** (either an image of a GIF) with the rendered components, so that users can better understand how the app works in practice. | ||
|
|
||
|  |
There was a problem hiding this comment.
This is an instruction to clarify which info should be added to the doc - It should be replaced with a real media!
Co-authored-by: Bia <[email protected]>
Co-authored-by: Bia <[email protected]>
guerreirobeatriz
approved these changes
Dec 18, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add a warning message that this project is unfinished.
What problem is this solving?
Warns general developers that this is an unfinished project.
How should this be manually tested?
N/A
Checklist/Reminders
README.md.CHANGELOG.md.Screenshots or example usage
Type of changes
Notes