StoneCreek Docs
Find answers, setup guides, and step-by-step help.
Getting started with StoneCreek Docs
Learn the basic StoneCreek Docs workflow: upload a plugin ZIP, review the generated documentation plan, create articles, and publish the documentation portal.
StoneCreek Docs helps you turn a WordPress plugin ZIP into a documentation set and a published portal. Use it to analyze a plugin package, review the proposed article outline, generate the articles you want, and publish the finished documentation on your site.
Before you begin
- You need access to the WordPress admin area.
- Your user account must be able to manage the plugin.
- If you plan to generate content with OpenAI, make sure an API key is available before you start.
1. Open StoneCreek Docs
- Go to your WordPress admin dashboard.
- Open StoneCreek Docs.
- Use the Analyze / Upload ZIP area to begin a new documentation project.
2. Upload and analyze a plugin ZIP
- Choose the plugin ZIP file you want to document.
- Start the analysis.
- Wait for the scan to finish before moving on.
StoneCreek Docs reviews the contents of the ZIP and prepares information that it uses to plan your documentation.
3. Review the documentation plan
- Look over the proposed article list.
- Check the article titles, sections, and purposes to make sure they match what you want to publish.
- Adjust your approach before generating content if the plan does not cover the right topics.
This review step helps you confirm that the documentation set focuses on the features and workflows that matter most for your project.
4. Generate the articles you want
- Select the articles you want StoneCreek Docs to create.
- Run the generation step.
- Review the generated articles in WordPress.
The plugin creates documentation as WordPress content, so you can edit each article before it goes live.
5. Publish and manage the portal
- Open Publishing & Portal from the StoneCreek Docs menu.
- Choose the publishing and portal options you want to use.
- Save your changes and confirm that the portal displays the articles the way you expect.
When the portal is ready, visitors can use it as a branded documentation site for your plugin.
Tips for a smooth setup
- Start with a ZIP that contains the plugin version you want to document.
- Review the plan before generating large batches of articles.
- Use the portal area to confirm how the published documentation will appear to readers.
Related tasks
- Analyze a new plugin release and refresh the documentation.
- Generate a smaller set of articles first, then expand the portal once you are happy with the results.
- Adjust publishing settings before sharing the portal with your audience.
