feat: add manifest-driven doc screenshot workflow#64
Draft
evrpress wants to merge 42 commits into
Draft
Conversation
… button documentation - Updated .gitignore to include new screenshot directories while excluding unnecessary files. - Added new development dependencies: `@playwright/test`, `looks-same`, and `pngjs` in package.json and package-lock.json. - Removed outdated button documentation and associated assets from the docs directory.
- Deleted the empty mcp.json file from the .cursor directory as it is no longer needed.
- Revised button documentation to clarify the usage of Freemius Checkout and options menu. - Updated image assets for button checkout and key settings to reflect recent changes. - Enhanced the settings documentation with clearer instructions for product configuration.
- Added new logic to capture and annotate the Freemius panel and its controls during the button checkout screenshot process. - Introduced a constant for the annotation inset to improve the clarity of the captured images. - Updated the button checkout screenshot generation to include visual highlights for better user guidance.
- Added a new section in the README and user guide for creating a pricing page, providing step-by-step instructions. - Updated the image manifest to include a screenshot of the published pricing page, enhancing visual documentation. - Improved the mapping documentation to clarify the behavior of mapped values in relation to product data updates.
- Revised the user guide to clarify the editor view of the pricing page with updated descriptions and image alt text. - Updated the image manifest to reflect changes in the screenshot description for the pricing layout. - Enhanced the screenshot capture functionality for the pricing table section in the editor.
- Revised the user guide to include the Products tab in the Freemius settings, enhancing clarity on product configuration. - Updated image assets to reflect the new Products tab screenshot. - Improved screenshot capture functionality to include the Products tab for better documentation.
- Revised user guide to clarify the enabling of Freemius in the editor, including updated descriptions and image alt text. - Updated image assets to reflect the new annotations and descriptions for the Freemius panel in the context of scoped blocks. - Enhanced screenshot capture functionality to accurately depict the Freemius settings in the editor.
- Revised the user guide to improve the organization of steps for creating a pricing page, renumbering sections for consistency. - Clarified instructions for adding pricing toggles, columns, and mapping plan fields to enhance user understanding. - Updated section titles to reflect the new order and ensure a logical flow in the documentation.
- Revised the user guide to include an updated screenshot of the pricing page editor, enhancing clarity on the modifier toggle row. - Added a new entry in the image manifest for the pricing modifier toggles, improving visual documentation. - Enhanced screenshot capture functionality to accurately depict the pricing page modifiers row in the editor.
- Revised the user guide to clarify the structure and steps for adding scoped columns for each pricing plan, improving user understanding. - Updated section titles and instructions to reflect the new organization of content. - Added a new entry in the image manifest for the pricing plan column screenshot, enhancing visual documentation. - Improved screenshot capture functionality to accurately depict the pricing page with scoped columns in the editor.
- Updated the user guide to include a new screenshot of the pricing page editor with the checkout button selected, improving clarity on the Freemius Checkout feature. - Added a new entry in the image manifest for the pricing checkout button screenshot, enhancing visual documentation. - Improved screenshot capture functionality to accurately depict the pricing page with the checkout button and its settings in the editor.
- Revised the user guide to include an updated screenshot of the pricing page editor with the checkout preview open, improving clarity on the checkout process. - Added a new entry in the image manifest for the pricing page preview screenshot, enhancing visual documentation. - Improved screenshot capture functionality to accurately depict the pricing page with the checkout preview overlay in the editor.
- Expanded the README to provide a comprehensive overview of the Freemius for WordPress plugin, emphasizing Block Editor support and key features. - Revised the user guide to clarify the plugin's architecture and how it utilizes the Freemius API for product data management. - Enhanced documentation structure with clear sections for installation, requirements, and related guides, improving user navigation and understanding.
- Enhanced the README to provide clearer instructions and details on using the Freemius checkout with the Block Editor, emphasizing ease of integration and key features. - Added a new screenshot entry in the image manifest for the documentation homepage preview, improving visual guidance for users. - Updated screenshot capture functionality to accurately reflect the checkout preview in the editor, ensuring better documentation quality.
- Updated the README to provide a more detailed overview of the steps for installing the plugin and building a pricing page. - Expanded the getting started guide with clear instructions on creating a pricing page, including adding groups, columns, and buttons for Freemius Checkout. - Improved documentation clarity to facilitate user understanding of the integration process.
- Revised the button guide to clarify usage, including standalone and scoped configurations for Freemius Checkout. - Streamlined the getting started section to direct users to the appropriate resources for installation and testing. - Updated settings documentation to reflect changes in how scoped blocks and buttons override site-wide defaults, enhancing user understanding.
…llback feature - Revised the button guide to include detailed information on the Track Callback functionality, enhancing user understanding of advanced tracking options. - Updated the image manifest to remove outdated screenshots and add new entries for the Track Callback popout editor, improving visual documentation. - Enhanced screenshot capture functionality to accurately reflect the Track Callback feature in the editor, ensuring better guidance for users.
- Replaced the outdated screenshot in the button guide with a new image of the pricing page editor showcasing the checkout preview, enhancing visual clarity for users. - Ensured the documentation accurately reflects the current user interface for better guidance on using the Preview feature.
… table - Replaced the outdated screenshot in the button guide with a new image showcasing the mapped Freemius checkout button within a pricing table, enhancing visual clarity for users. - Updated the documentation to reflect the new layout and provide better guidance on using the checkout button in the context of pricing tables. - Added a new entry in the image manifest for the button overview screenshot, improving visual documentation consistency.
- Updated the type definition in the screenshot documentation script to allow optional `doc` properties in the embed object, enhancing flexibility. - Modified the filtering logic to ensure only entries with a defined `doc` are processed, improving the accuracy of the generated documentation.
- Removed the mention of the Freemius public key as a required setting in the button guide, streamlining the documentation for users. - Ensured the key settings section remains clear and focused on essential configuration details.
… feature - Replaced the button track callback screenshot with a new version, enhancing visual clarity for users. - Updated the image manifest to reflect the new padding configuration for the Track Callback screenshot, ensuring accurate documentation of the feature.
- Removed the outdated tracking examples link from the button guide, streamlining the documentation for users. - Ensured the remaining content focuses on current tracking options and enhances clarity for advanced tracking features.
- Revised the README to clarify the structure and functionality of scopes in the pricing table editor, including visual indicators for parent and child scopes. - Added a new screenshot entry in the image manifest for the pricing plan column scopes, enhancing visual documentation for users. - Improved the screenshot capture script to accurately reflect the updated layout and annotations for the pricing table scopes.
…g Page setup - Introduced new documentation files for the Freemius Button and Creating your Pricing Page, detailing setup, key settings, and customization options. - Included step-by-step instructions for building a multi-plan pricing page, emphasizing the importance of mapped fields and scope modifiers. - Enhanced user guidance with visual aids and links to related documentation, ensuring clarity in the integration process.
- Revised documentation to ensure all references to markdown files are consistent, changing `docs/user-guide/` to `docs/` across multiple files. - Updated image paths in documentation to remove the `../` prefix, ensuring clarity and consistency in asset referencing. - Enhanced the image manifest to reflect the updated documentation structure, improving overall documentation accuracy.
- Introduced new documentation files for field mapping, scope modifiers, and scopes, detailing their functionalities and usage within the Freemius plugin. - Included visual aids to enhance understanding of how to configure mappings and modifiers in the block editor. - Provided guidance on the relationship between scopes and mapped fields, improving clarity for users setting up pricing pages.
- Updated all documentation to ensure consistent linking to markdown files by removing unnecessary prefixes and ensuring uniformity across references. - Revised image paths in the documentation to eliminate the `../` prefix, enhancing clarity and consistency in asset referencing. - Adjusted the image manifest to reflect these changes, improving overall documentation accuracy and user experience.
- Deleted obsolete button images that are no longer relevant to the documentation, streamlining asset management. - Ensured the documentation remains focused on current visuals and enhances clarity for users.
- Revised the modifiers documentation to provide a clearer description of the Freemius Scope modifier block, enhancing user understanding. - Updated the associated screenshot to accurately reflect the current layout and settings in the pricing page editor. - Adjusted the image manifest to ensure consistency with the new documentation and visual assets.
- Deleted obsolete entries for button preview and configuration scopes from the image manifest, streamlining asset management. - Updated the screenshot capture script to reflect the removal of these outdated functions, ensuring documentation remains focused on current features.
- Replaced multiple binary image files to enhance visual clarity and ensure they accurately represent the current features in the documentation. - Updated assets include button key settings, button overview, homepage preview, pricing page elements, and scope pricing mappings.
- Added a new image to the getting started documentation to illustrate the Freemius Checkout button settings in the editor. - Updated the image manifest to include documentation references for the newly added visual asset, ensuring clarity and context for users.
- Replaced references to the outdated Freemius Checkout button with the new button overview in the documentation. - Deleted the obsolete button-checkout image from the assets to streamline visual resources. - Updated the image manifest and related scripts to reflect these changes, ensuring documentation accuracy and clarity for users.
- Removed outdated editor view image with purple scope outlines to streamline content. - Added information about child scopes and their properties to enhance user understanding of block inheritance. - Updated references to ensure consistency and clarity in the documentation.
- Moved the section on pricing toggles to follow the column scope mapping, enhancing logical progression in the setup instructions. - Updated the step numbers in the getting started guide to reflect the new order, ensuring clarity for users. - Maintained detailed instructions for adding pricing toggles, ensuring users have comprehensive guidance on functionality.
- Updated the pricing page documentation to specify that modifiers for currency, billing cycle, and license count are optional. - Revised the instructions for adding pricing toggles to emphasize their optional nature and when to use them. - Ensured consistency in the step-by-step guide for a clearer user experience.
- Corrected the placement of the "Creating your Pricing page" entry to eliminate duplication in the guide table. - Ensured the documentation maintains clarity and consistency for users navigating the pricing page setup.
- Revised instructions for adding Freemius Modifier blocks, emphasizing their placement within scoped areas. - Added details on style variants available for modifiers, enhancing user understanding of customization options. - Ensured consistency and clarity in the documentation to improve the user experience when setting up pricing options.
Keep Cursor config in a local nested repo under .cursor/ and ignore it in the plugin repository so it is not pushed to origin. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduces a CoverKit-inspired screenshot pipeline for Freemius documentation: image-manifest.json as the single registry, Playwright capture scripts, gitignored screenshots/ sources, and Cursor /screenshot + /update-screenshots commands. Expands docs/ into a user-guide tree with placeholder manifest entries for existing images, using post 428 and dev.local/playground/ as fixtures.
Adds screenshots/image-manifest.json, Playwright scripts under scripts/, npm run update-screenshots, .cursor commands/skills, and reorganized docs/user-guide/ markdown. Raw captures live in screenshots/ (gitignored); committed PNGs stay in docs/assets/. No Astro site — plain markdown only.
Documentation images were scattered across GitHub URLs and hand-maintained assets with no regen path. Site owners and contributors need repeatable, local captures tied to a fixture page as the plugin UI evolves.