Conversation
Add a docs/ directory with a Docsify-based documentation site covering: - Overview and quick-start guide - Architecture and design (service topology, job lifecycle, subprocess plugin design) - Configuration reference (env vars, config files, ports) - Job management (submit, status, kill, polling patterns) - CI integration guide (using panda-compose as a GitHub Actions service) Add .github/workflows/docs.yml to publish docs/ to GitHub Pages on every push to main that touches the docs or README. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Docsify-based documentation site under docs/ and a GitHub Actions workflow to deploy the generated static site to GitHub Pages, providing end-user setup/reference material for running and integrating with the local PanDA stack.
Changes:
- Introduces a Docsify site entrypoint (
docs/index.html) plus sidebar/navigation. - Adds multiple documentation pages covering quick start, architecture, configuration, job management, and CI integration.
- Adds a GitHub Actions workflow to publish the docs site to GitHub Pages on pushes to
main.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
docs/index.html |
Docsify site configuration and JS/CSS asset loading. |
docs/_sidebar.md |
Sidebar navigation for the Docsify site. |
docs/README.md |
Docs landing page / overview content. |
docs/getting-started.md |
Quick start instructions for running the stack and submitting a first job. |
docs/architecture.md |
Architecture/service topology and job lifecycle documentation. |
docs/configuration.md |
Environment/config file and port reference documentation. |
docs/job-management.md |
How to submit/query/cancel jobs and expected status/timing. |
docs/ci-integration.md |
Guidance and example workflow for using the stack in CI. |
docs/.nojekyll |
Ensures GitHub Pages doesn’t run Jekyll processing. |
.github/workflows/docs.yml |
GitHub Pages deployment workflow for the docs site. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…rkflow - Service topology: ASCII box art → Mermaid graph TD - Service dependency order: table → Mermaid graph LR with phase subgraphs - Job lifecycle: ASCII sequence → Mermaid sequenceDiagram - Job lifecycle timing: ASCII flow → Mermaid stateDiagram-v2 - docs/index.html: add docsify-mermaid plugin - .github/workflows/docs.yml: remove 'cp README.md _site/' which overwrote the docs/README.md already copied by 'cp -r docs/* _site/' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Wouter Deconinck <wdconinc@gmail.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
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.
Adds a docs/ directory with a Docsify-based documentation site, published to GitHub Pages via a new GitHub Actions workflow.
Documentation pages added:
The .github/workflows/docs.yml workflow deploys docs/ to GitHub Pages on every push to main that touches docs or README.
Note: after merging, GitHub Pages must be enabled under Settings -> Pages -> Source -> GitHub Actions.