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

Update wp-now documentation #251

Merged
merged 7 commits into from
May 22, 2024
Merged

Update wp-now documentation #251

merged 7 commits into from
May 22, 2024

Conversation

ironnysh
Copy link
Contributor

@ironnysh ironnysh commented May 1, 2024

What?

Updating the wp-now README file.

Why?

Some information was outdated or missing.

See details in this issue.

Testing Instructions

Review the text :-)

ironnysh added a commit to WordPress/wordpress-playground that referenced this pull request 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
Copy link

@flexseth flexseth left a comment

Choose a reason for hiding this comment

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

made some suggestions, let's continue the discussion! The main point is (personally) - I think the page should probably be broken out into multiple pages

Nice changes for readability and functionality so far!

packages/wp-now/README.md Show resolved Hide resolved
packages/wp-now/README.md Show resolved Hide resolved
packages/wp-now/README.md Show resolved Hide resolved
packages/wp-now/README.md Show resolved Hide resolved
packages/wp-now/README.md Outdated Show resolved Hide resolved
packages/wp-now/README.md Show resolved Hide resolved
packages/wp-now/README.md Show resolved Hide resolved
@ironnysh
Copy link
Contributor Author

ironnysh commented May 2, 2024

Thanks, @flexseth!

Copy link

@flexseth flexseth left a comment

Choose a reason for hiding this comment

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

Changes look good. Thanks @ironnysh!!

As more changes come to the wp-now interface, the docs will most likely mature in time. Going to try to track changes and keep a log of docs pages that can be updated as new features and modifications come online. Thanks again for taking a look!!

@ironnysh
Copy link
Contributor Author

ironnysh commented May 6, 2024

Cheers, @flexseth, and thanks for the review.

the docs will most likely mature in time.

Sure, just important to remember the distinction between the docs and the README 😄 especially while the current setup (Docusaurus) remains.

Going to try to track changes and keep a log

Not sure if it covers both repos (wordpress-playground and playground-tools), but @adamziel recently set up a cool automatic changelog that's also available on the official docs.

@adamziel
Copy link
Collaborator

I left one note but it looks great to me otherwise, thank you so much @ironnysh! CC wp-now folks: @sejas @wojtekn

Copy link
Collaborator

@sejas sejas left a comment

Choose a reason for hiding this comment

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

@ironnysh , the changes look good.
I left a couple of comments, my biggest concern is removing the Publishing/Releasing section. As @adamziel said, let's keep it here or link it to a new file.

packages/wp-now/README.md Show resolved Hide resolved
packages/wp-now/README.md Show resolved Hide resolved
packages/wp-now/README.md Show resolved Hide resolved
@ironnysh
Copy link
Contributor Author

@adamziel @sejas -- I think it's ready

@sejas
Copy link
Collaborator

sejas commented May 22, 2024

Beautiful! Thanks for your hard work @ironnysh 🙏

@sejas sejas merged commit df6c924 into WordPress:trunk May 22, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants