User guide updates for adding content blocks #109
Conversation
|
Pull requests must include at least one of the required labels: |
|
Where to add in the docs: 
|
|
here's a comment rod left for me. i'll adjust step 3 to reflect there only being a simple text block. the initial pr will still exist for when test driven blocks are added, so i can come back and reference it when i need to update the docs for that. |
|
Pull requests must include at least one of the required labels: |
|
here's the new docs page. i've edited step 3 as per rod's comment, and i added the page to the left navbar under Document Models with the Validmind UI. pinging @nrichers for review |
|
Pull requests must include a description in the release notes section. |
There was a problem hiding this comment.
Another great docs PR from you, @p-m-s-f! I had some minor comments and will approve once the extraneous files are removed. Let me know what you think about creating an animated GIF, I'm happy to go with your judgement on this.
|
Pull requests must include a description in the release notes section. |
|
Pull requests must include a description in the release notes section. |
nrichers
changed the title
There was a problem hiding this comment.
Looks good. @nrichers we can push the "test driven" blocks documentation on a separate PR unless you want to publish those two at the same time.
In terms of the GIFs with weird capitalization (Simple text Block), we will re-deploy to dev later today once we have some cosmetic fixes finalized (cc @gtagle).
@cachafla I had included some basic info for test driven blocks was I thought they would not be released this time around? If they will be, I can update this PR with some more info. I can also update the animated GIF after the latest UI changes go in. |
* docs page for adding content block * edited step 3 & added to left navbar * Expand topic with more info, add animated GIF * Remove markdowntest file * Remove comment from source * Add steps for test-driven content blocks, interim GIF update * Text edit * Text edit --------- Co-authored-by: Nik Richers <nik@validmind.ai>
This PR includes docs for adding content blocks, including a small animated GIF to show how the functionality works:
Original PR description from Parris
Responding to this story. I've written a rough draft to hand off to Nik. Currently, this new page is lumped in with the other guides, and doesn't have a reference along the left hand navbar.
I also found and corrected a typo on another page:
External Release Notes
You can now add new sections, known as content blocks to documentation projects. This feature enables you to modify your existing documentation projects by directly editing them in the Platform UI. Learn more ...