Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the description of SetSiteOptionsStep #1291

Closed
juanmaguitar opened this issue Apr 22, 2024 · 7 comments
Closed

Improve the description of SetSiteOptionsStep #1291

juanmaguitar opened this issue Apr 22, 2024 · 7 comments
Assignees
Labels
[Package][@wp-playground] Blueprints [Type] Documentation Improvements or additions to documentation

Comments

@juanmaguitar
Copy link
Collaborator

On page https://wordpress.github.io/wordpress-playground/blueprints-api/steps/#SetSiteOptionsStep

This is equivalent to calling update_option

Add a link to https://developer.wordpress.org/reference/functions/update_option/ on update_option

options (Record) – The options to set on the site.

Add a link to the list of options that could be set in this step on "The options"

@ironnysh
Copy link
Collaborator

Great suggestion, @juanmaguitar.

I wonder if it'll make sense to add references to the Developer docs in other relevant steps as well. Basically anything that isn't SQL or file system :-)

@ironnysh ironnysh added [Type] Documentation Improvements or additions to documentation [Package][@wp-playground] Blueprints labels Apr 22, 2024
@adamziel
Copy link
Collaborator

Yes it would @ironnysh, great idea!

@ironnysh
Copy link
Collaborator

ironnysh commented Apr 22, 2024

Coolio!

Cross-referencing additional developer-related improvements to the docs:

  • Reorganize the chapters
  • Revise the Contributing chapter
  • wp-now Docs
  • Misc

@ironnysh ironnysh self-assigned this Apr 22, 2024
@ironnysh
Copy link
Collaborator

Hmm, so I hit a blocker:
The steps descriptions are provided in multiple typescript files found in this directory.
That's not a problem, except they are written as code comments that are parsed here (I think 🙂).
Adding (HTML or markdown) links to the text of the comments has no effect on the generated content. Only code markup is currently supported.
What's the best way to handle this, @adamziel?

@adamziel
Copy link
Collaborator

@ironnysh ah, bummer. Hm, proceed as if Markdown was supported and I'll make that happen :-)

@ironnysh
Copy link
Collaborator

Magic! :-)) So, just to make sure, when you say

proceed as if Markdown was supported

You mean this?

/**
 * Sets site options. This is equivalent to calling [`update_option`](https://developer.wordpress.org/reference/functions/update_option/) for each
 * option in the [`options`]( https://developer.wordpress.org/apis/options/#available-options-by-category) object.
 */

Added [word](url) markdown links to the comment in site-data.ts)

@adamziel
Copy link
Collaborator

Yup!

@ironnysh ironnysh closed this as completed May 1, 2024
ironnysh added a commit that referenced this issue May 1, 2024
## What is this PR doing?

1. Reorganizing the **Contributing** chapter of the docs, and updating
the content. See [this
issue](adamziel/playground-docs-workflow#31 (comment))

2. Adding references to [the Developer
docs](https://developer.wordpress.org/) in relevant Blueprints steps.
See #1291.

~### To-Do:~

- [x] Update [wp-now](https://www.npmjs.com/package/@wp-now/wp-now)
README.

**Done** in [Update wp-now documentation
#251](WordPress/playground-tools#251).

## Testing Instructions
1. Build the site (standard `npm run build` to update the steps in
`packages/playground/blueprints/src/lib/steps/`)
2. Run `npm run dev:docs`.
3. Review the changes.

@adamziel
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package][@wp-playground] Blueprints [Type] Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants