Skip to content

CodeBoarding [Diagram-First Documentation]

Actions
Generates diagram-first visualizations of your codebase using static analysis and large language models
0.0.1
LatestPre-release
Star (0)

Tags

 (1)
CodeBoarding Logo

CodeBoarding [Diagram-First Documentation]

GitHub Action

Generates diagram-first visualizations of your codebase using static analysis and large language models.

Usage

name: Generate Documentation
on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  documentation:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        
      - name: Generate Documentation
        uses: your-username/CodeBoarding-GHAction@v1
        with:
          repository_url: ${{ github.server_url }}/${{ github.repository }}
          output_directory: '.codeboarding'
          
      - name: Upload Documentation
        uses: actions/upload-artifact@v4
        with:
          name: documentation
          path: .codeboarding/

Inputs

Input Description Required Default
repository_url Repository URL for which documentation will be generated Yes -
output_directory Directory where documentation files will be saved No .codeboarding

Outputs

Output Description
files_created Number of files created
output_directory Directory where files were saved
has_changes Whether any files were created or changed

License

MIT License - see LICENSE file for details.

CodeBoarding [Diagram-First Documentation] is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Generates diagram-first visualizations of your codebase using static analysis and large language models
0.0.1
LatestPre-release

Tags

 (1)

CodeBoarding [Diagram-First Documentation] is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.