Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions tools/library-setup/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Library Setup Tool

Generate block documentation for your DA.live library from GitHub repositories.

## Setup Mode

![Library Setup Mode](./images/setup-mode.png)

Use this mode to create a new block library from scratch:

- Enter your GitHub repository URL to discover blocks
- Private repositories supported - enter a GitHub token when prompted
- Select which blocks to include in your library
- Blocks are automatically analyzed for structure, variants, and features
- Placeholder documentation generated based on block code analysis
- Optionally select sample pages to extract real content examples
- Creates library structure in DA.live with blocks.json configuration
- Updates site configuration to register the library

## Refresh Documentation Mode

![Refresh Documentation Mode](./images/refresh-mode.png)

Use this mode to update existing block documentation with new content:

- No GitHub repository required - reads from existing library
- Enter your DA.live organization and site name
- Select which blocks to update
- Add new sample pages to extract fresh content examples
- Only updates blocks found in the selected pages
- Preserves existing blocks not being updated
- Maintains all library configuration settings

## Requirements

- Must be run from within DA.live for authentication
- GitHub token needed only for private repositories (can be saved for future use)
- Sample pages optional - tool generates intelligent placeholders without them
Loading
Loading