StoneCreek Docs
Find answers, setup guides, and step-by-step help.
Work with documentation versions
Track documented plugin versions, decide whether an uploaded release starts a new project or updates an existing one, and compare changes before generating refreshed documentation.
StoneCreek Docs helps you keep documentation aligned with the plugin version you are working on. When you upload a plugin ZIP, the project can record both the uploaded version and the version that is already documented, so you can decide whether the new upload should update the current project or start a new one.
How version tracking helps
Version tracking gives you a simple way to tell whether the documentation you already have still matches the plugin release you just uploaded. If the new upload belongs to an existing project, StoneCreek Docs can compare the latest analysis with the last saved snapshot and highlight changed areas such as shortcodes, settings, admin menus, capabilities, AJAX actions, REST routes, roles, and integrations.
This makes it easier to spot when a plugin update may need a refreshed documentation plan before you generate or republish articles.
What happens when you upload a plugin ZIP
- StoneCreek Docs reads the plugin name, text domain, and version from the upload.
- It looks for an existing project that matches the plugin.
- If a matching project exists, the upload is treated as a possible update and the documented version can be compared with the uploaded version.
- If no matching project exists, the upload can become a new project.
After the upload is analyzed, you can choose whether to update the existing project or create a new one.
Choose between updating and starting a new project
When StoneCreek Docs detects an existing project, you can keep the current project and treat the upload as an update, or create a separate project for the new release line.
- Update an existing project when the upload is the next version of the same plugin documentation.
- Create a new project when the upload should be documented separately from the current release line.
Choosing the right option keeps version history organized and makes it easier to match documentation to the plugin release your team is supporting.
Use the change comparison to review updates
After a new analysis is compared with the previous one, StoneCreek Docs can show where the plugin has changed. Use that comparison to focus your review on the areas most likely to affect documentation.
Pay special attention to any changed feature areas before you plan or generate new articles. If a release adds or removes user-facing behavior, that is a strong signal that your documentation should be refreshed.
Recommended workflow for a plugin update
- Upload the new plugin ZIP.
- Check whether StoneCreek Docs matches it to an existing project.
- Review the uploaded version and the documented version.
- Look over the change comparison for anything that affects users.
- Choose whether to update the current project or start a new one.
- Regenerate the documentation plan if the release changed user-facing behavior.
Tips for keeping versions organized
- Use the same project when you are documenting the same plugin across releases.
- Start a new project only when you want to separate documentation for a different release line or a different documentation effort.
- Review the change comparison before generating articles so you do not miss updated settings, menu items, or integrations.
Related tasks
- Upload and analyze a plugin ZIP
- Choose whether an analyzed plugin should update an existing project or start a new one
- Generate a documentation plan for the current project
