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

Docs: Add documentation site #35

Open
kraftbj opened this issue Feb 20, 2025 · 1 comment
Open

Docs: Add documentation site #35

kraftbj opened this issue Feb 20, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation [Type] Enhancement New feature or request

Comments

@kraftbj
Copy link
Contributor

kraftbj commented Feb 20, 2025

To provide documentation for the plugin, we're spinning up a new "handbook" on developer.wordpress.org (DevHub).

Work on the developer.wordpress.org site itself is tracked via https://meta.trac.wordpress.org/ticket/7917

The source of truth for the documentation will be the docs folder within this repo. See #31.

I made an initial pass on a documentation set, but it is very far from complete or robust. PRs accepted to add/update documentation.

Documentation for existing, released features can include a composer docs run to update the manifest file used for ingesting to DevHub. If a feature is totally new for an upcoming release, we can defer composer docs until when finalizing the release.

@kraftbj
Copy link
Contributor Author

kraftbj commented Feb 21, 2025

Current status: The DevHub site is visible at https://developer.wordpress.org/secure-custom-fields/ and not currently linked from the homepage.

The manifest is being ingested with pages created. There is automatic parsing of docblocks, converted to markdown.

The ingestion isn't right yet; some files lacking titles, the "SCF" page is being added anew over and over again, etc. Progress, though.

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 [Type] Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant