Merge pull request #2 from homingos/dev - #4
Open
bucharitesh wants to merge 21 commits into
Open
Conversation
…improved structure - Added development and local API URLs to the OpenAPI document for better testing options. - Reformatted sections for security, tags, headers, and schemas to improve readability and consistency. - Ensured all schema properties are clearly defined with proper indentation for clarity.
- Eliminated outdated development and local API URLs to streamline the OpenAPI document. - Maintained focus on the production API for clarity and relevance.
- Modified the input structure in the authentication and running apps sections to use an array format with `node_id` and corresponding values. - Clarified the error handling documentation to specify the required input format. - Updated the OpenAPI specification to align with the new input schema, ensuring consistency across documentation. - Enhanced descriptions for input and output fields to improve clarity for developers.
- Updated AGENTS.md to provide a clearer authoring guide and page conventions, including frontmatter requirements and video embedding instructions. - Revised docs.json to reflect a new navigation structure with expanded groups and added redirects for moved pages. - Enhanced index.mdx with a more comprehensive description of Flowy's capabilities and improved call-to-action cards. - Removed quickstart.mdx as part of the restructuring. - Introduced new references for video documentation and conventions to standardize content creation. - Added keyboard shortcuts documentation for improved user experience in the canvas and Studio. - Updated billing documentation to clarify credit usage and plan comparisons, including a new Plans & Pricing page.
- Added a new `recording.md` file detailing the recording harness setup and usage for video documentation. - Introduced new scripts for probing and setting up image tools and studio interactions, enhancing the recording capabilities. - Updated `.gitignore` to include `.DS_Store` for cleaner project management. - Created additional probe scripts to facilitate exploration of various features within the application.
- Revised captions for demo videos in the image tools documentation to provide clearer descriptions of functionality. - Added new image tool scripts for Change Angle, Inpaint, Separate Layers, Outpaint, and Upscale, enhancing the recording capabilities for these features. - Introduced new poster images for various image tools to improve visual representation in the documentation. - Removed deprecated setup script for image tools to streamline the project structure.
…cumentation - Changed the contact email from hello@flowy.ai to hello@tryflowy.ai for enterprise plan inquiries to ensure correct communication.
- Deleted the Motion Path node documentation from canvas/nodes/motion-path.mdx. - Removed references to the Motion Path node from docs.json and canvas/nodes/overview.mdx to streamline the documentation.
…LI page
- Sync api-reference/openapi.json with the backend spec: adds
/v1/generations[/{id}], /v1/assets[/{id}], /v1/credits (workspace_id),
/v1/account, /v1/account/transactions, /v1/workspaces.
- New endpoint pages for all of the above, wired into the API Reference nav.
- New "MCP & CLI" page: hosted MCP setup, the 9 tools, and the flowy CLI
(auth, account status/transactions, workspace list/set/status/unset/credits,
mcp install/stdio, version).
- Authentication page: OAuth connections are account-bound (account wallet
by default, workspace_id to act in a managed workspace); dashboard API
keys stay workspace-bound.
Sync the OpenAPI spec (19 paths, v1.3.0): audio & 3d generation types,
/v1/projects, /v1/projects/{id}/nodes, /v1/brandkits CRUD + extract,
/v1/renders. New endpoint pages, nav, and MCP/CLI page (18 tools, generate/
project/node/brandkit CLI commands).
…video assets - Introduced a new pnpm lockfile for dependency management. - Added authentication configuration files for collaboration and state management. - Included multiple raw video assets for canvas and dashboard functionalities. - Enhanced the recording capabilities with various new video formats for different features.
Splits the flat 20-item Endpoints list into labeled sub-groups (Apps, Generations, Assets, Projects & nodes, Brand kits, Renders, Account & credits, OpenAPI) so the surface is scannable at a glance.
Closes the last endpoint without a docs page; slotted into the Brand kits group after create.
Feat/docs rewrite videos
…missions); document POST /v1/apps (create a flow, apps:write); /v1/apps paths kept
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
4 participants
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.
Dev