Skip to content

Update the Blueprint data format doc - #1510

Merged
adamziel merged 3 commits into
trunkfrom
docs-update-blueprint-data-format
Jul 3, 2024
Merged

Update the Blueprint data format doc#1510
adamziel merged 3 commits into
trunkfrom
docs-update-blueprint-data-format

Conversation

@ndiego

@ndiego ndiego commented Jun 13, 2024

Copy link
Copy Markdown
Member

This PR makes some light updates to the Blueprint data Format documentation. The doc is now more streamlined, and code examples are provided for each property. I also added a dedicated section for Steps.

Titles are also now in sentence case to match the WP style guide.

@ndiego ndiego added the [Type] Documentation Improvements or additions to documentation label Jun 13, 2024
@ndiego
ndiego requested review from adamziel and bgrgicak June 13, 2024 02:39
@ndiego ndiego self-assigned this Jun 13, 2024
Comment thread packages/docs/site/docs/09-blueprints-api/03-data-format.md Outdated

- `light`: Default choice. Saves 6MB of downloads, loads none of the extensions below.
- `kitchen-sink`: Installs [`gd`](https://www.php.net/manual/en/book.image.php), [`mbstring`](https://www.php.net/manual/en/mbstring.installation.php), [`iconv`](https://www.php.net/manual/en/function.iconv.php), [`openssl`](https://www.php.net/manual/en/book.openssl.php), [`libxml`](https://www.php.net/manual/en/book.libxml.php), [`xml`](https://www.php.net/manual/en/xml.installation.php), [`dom`](https://www.php.net/manual/en/intro.dom.php), [`simplexml`](https://www.php.net/manual/en/book.simplexml.php), [`xmlreader`](https://www.php.net/manual/en/book.xmlreader.php), [`xmlwriter`](https://www.php.net/manual/en/book.xmlwriter.php)
- `light`: Default choice. It saves 6MB of downloads and loads none of the extensions below.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kitchen-sink is now the default.

It looks like default was updated in the docs on Apr 3rd here but was mistakenly reverted here (cc @flexseth).

@brandonpayton

Copy link
Copy Markdown
Member

Thank you for the updates. I left a couple of notes, but the changes look good to me overall.

Co-authored-by: Brandon Payton <brandon@happycode.net>
@adamziel

adamziel commented Jul 3, 2024

Copy link
Copy Markdown
Collaborator

@brandonpayton feel free to merge (and make a call on merging PRs in general).

@adamziel

adamziel commented Jul 3, 2024

Copy link
Copy Markdown
Collaborator

Ah, I see, there's still pending feedback. Pingy ping @ndiego

@ndiego

ndiego commented Jul 3, 2024

Copy link
Copy Markdown
Member Author

Ah, I see, there's still pending feedback. Pingy ping @ndiego

Oops, sorry about that. I just made the update requested. Should be all good!

@adamziel
adamziel merged commit d1726c2 into trunk Jul 3, 2024
@adamziel
adamziel deleted the docs-update-blueprint-data-format branch July 3, 2024 15:25
@adamziel

adamziel commented Jul 3, 2024

Copy link
Copy Markdown
Collaborator

Thank you so much @ndiego !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation

3 participants