StoneCreek Docs

KNOWLEDGE BASE

StoneCreek Docs

Find answers, setup guides, and step-by-step help.

StoneCreek Docs›Analyze a plugin ZIP

Analyze a plugin ZIP

Upload a WordPress plugin ZIP so StoneCreek Docs can inspect it and prepare a documentation project for the next steps in the workflow.

Use this step when you want StoneCreek Docs to inspect a plugin package and prepare it for documentation. After the ZIP is analyzed, the plugin identifies the project, records what it found, and gets the documentation workflow ready for planning and generation.

Before you start

  • Make sure you have a plugin ZIP file ready to upload.
  • You need access to the StoneCreek Docs area in WordPress.
  • You must have permission to manage the plugin’s documentation workflow.

Upload and analyze the ZIP

  1. Go to the StoneCreek Docs area in your WordPress admin.
  2. Open the Analyze / Upload ZIP section.
  3. Choose the plugin ZIP file you want to inspect.
  4. Upload the file to start the analysis.

StoneCreek Docs reads the uploaded package, identifies the plugin, and stores the analysis for the current project. If the plugin appears to be new, it prepares a new project. If it matches an existing project, it prepares the update workflow for that project.

What the analysis prepares

Once the ZIP has been analyzed, the workflow is ready for the next documentation steps. The analysis helps StoneCreek Docs capture details such as the plugin’s identity and the features it detects inside the package, so you can move on to planning and generating documentation.

What happens next

After analysis, you can continue with the documentation workflow by reviewing the project state, planning the documentation set, and generating articles for the selected items.

Tips

  • If the ZIP is not accepted, confirm that you uploaded a plugin package and not a different type of archive.
  • If you are documenting a later version of an existing plugin, the analysis will help prepare the update path for that project.

Troubleshooting

  • If no file is selected, the workflow will stop and ask you to choose a plugin ZIP.
  • If the ZIP cannot be processed, verify that the file is a valid plugin archive.
Powered by StoneCreek Docs