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 readme files with editor-specific steps and screenshot references #555

Merged
merged 7 commits into from
Apr 11, 2024

Conversation

mikachan
Copy link
Member

This updates the readme files to add more info about using the panel provided by the plugin in the Editor, and adds references to the screenshots, so they should show in the plugin directory (following the instructions here).

I've also renamed "Site Editor" to just "Editor", as I believe this is more up to date.

@mikachan mikachan added the documentation Improvements or additions to documentation label Apr 10, 2024
README.md Outdated Show resolved Hide resolved
@pbking
Copy link
Contributor

pbking commented Apr 10, 2024

Embed Google Fonts or local font files

DEPRECATED: Fonts can now be managed using WordPress' native Font Library. More information.

CBT DOES enable this management in a way that native Font Library doesn't. I think we should mention that. Maybe...

Embed Fonts

Save fonts in your theme that have been installed with the Font Library (found in WordPress 6.5+).

README.md Show resolved Hide resolved
@pbking
Copy link
Contributor

pbking commented Apr 10, 2024

Where are the changes to how the screenshots are referenced? There isn't a way to test this is there? :P

mikachan and others added 3 commits April 10, 2024 17:52
@mikachan
Copy link
Member Author

Where are the changes to how the screenshots are referenced?

Good question that I should've made more obvious! They're on line 37, 54, 65, 71, and 81 of readme.txt. e.g. 1. Create Block Theme panel in the WordPress Editor. I believe the format is [Number that corresponds to the number in screenshot filename]. Image caption, from the instructions here.

There isn't a way to test this is there? :P

I don't think so!


- Create Block Theme
1. Create Block Theme panel in the WordPress Editor
Copy link
Member Author

Choose a reason for hiding this comment

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

This should embed screenshot-1.jpg with "Create Block Theme panel in the WordPress Editor" as the caption.


- Select "Theme Info" to edit the metadata for the theme. These details will be used in the style.css file.

2. Theme Info editing panel in the WordPress Editor
Copy link
Member Author

Choose a reason for hiding this comment

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

This should embed screenshot-2.jpg with "Theme Info editing panel in the WordPress Editor" as the caption.

- "Export Child Theme" to export a child of the currently active theme as a zip file.
- "Create Blank Theme" to create a new, blank theme with no styles or templates.

3. Create Theme panel in the WordPress Editor
Copy link
Member Author

Choose a reason for hiding this comment

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

This should embed screenshot-3.jpg with "Create Theme panel in the WordPress Editor" as the caption.


- Select "Inspect Theme JSON"

4. theme.json inspector in the WordPress Editor
Copy link
Member Author

Choose a reason for hiding this comment

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

This should embed screenshot-4.jpg with "theme.json inspector in the WordPress Editor" as the caption.


Many of these options are also available under the older, deprecated Create Block Theme page under Appearance > Create Block Theme.

5. Page under Appearance > Create Block Theme
Copy link
Member Author

@mikachan mikachan Apr 10, 2024

Choose a reason for hiding this comment

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

This should embed screenshot-5.jpg with "Page under Appearance > Create Block Theme" as the caption.

Copy link
Contributor

@pbking pbking left a comment

Choose a reason for hiding this comment

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

The words look good to me, I think we can 🚢 . I hope the screenshot bits work.

@mikachan mikachan merged commit b930cad into trunk Apr 11, 2024
2 checks passed
@mikachan mikachan deleted the update/plugin-readmes branch April 11, 2024 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants