adamziel / playground-docs-workflow

Experimenting with maintaining WordPress docs using WordPress Playground
https://adamziel.github.io/playground-docs-workflow/
11 stars 2 forks source link

Initial PR showcasing how to create docs using the Markdown to WordPress workflow #46

Open flexseth opened 4 months ago

flexseth commented 4 months ago

Here are a few starting docs, and a sample video for how I created them.

The Jetpack plugin with Markdown module enabled allowed me to import Markdown into WordPress.

I'm not sure if it was WP-CLI auto-formatting the Markdown files, or the editor understanding the post import that made this work so seamlessly.

When I created posts manually by copy/pasting the Markdown into a MD block in Jetpack, it included some unnecessary content wrappers.

Might test on another PR.

https://github.com/adamziel/playground-docs-workflow/assets/3792502/634f8818-7d04-44a9-8606-403005da3d15

Let me know what you think about the flow! I've got a lot more content incoming this week.

adamziel commented 4 months ago

As discussed in Slack – let's make sure all the documents in this PR are block markup, not HTML or Markdown. Also, I see some "TODO" comments, checklists, and incomplete lists. Please remove them as they will be confusing for someone reading these pages to learn from them.

flexseth commented 4 months ago

Filling in docs

How about including links to more information

More information link

add guidance:

See a section with a "More info" link? Help us improve the documentation!

Block markup conversion

When the content is imported via the wp-cli workflow mentioned above, it will be using the Classic Editor - if you click Convert to Blocks it will swap all blocks to block markup

flexseth commented 4 months ago

"TODO" comments, checklists, and incomplete lists. Please remove them as they will be confusing for someone reading these pages to learn from them.

Ok, I'll have to go back and update the files. There's been quite a bit of info filled in