Conversation
|
@copilot update markdown files in docs/src/content/docs/reference/frontmatter.md with a correct frontmatter for starlight. Minimum title and description. Infer title and description from each page content. |
|
@copilot update docs/src/content/docs/index.mdx for the current project (review readme.md, concepts and the documentation) for inspiration. |
…ocs (#749) * Initial plan * Add Starlight frontmatter to all reference documentation files Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot add github action workflow (docs.yml) that runs on workflow_dispatch or release: created. build the astro docs, uploads to github pages using artifacts. |
|
@copilot repair the links in the README.md file since .md files have been moved. |
|
@copilot follow astro best practices ( https://starlight.astro.build/guides/authoring-content/ ) with the markdown files in docs/src/content/docs/*.md |
* Initial plan * Update docs for GitHub Agentic Workflows and add docs deployment workflow - Updated index.mdx to properly represent GitHub Agentic Workflows project - Added GitHub Actions workflow for building and deploying docs to GitHub Pages - Verified all reference docs already have proper Starlight frontmatter Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
* Initial plan * Fix broken documentation links in README.md after Starlight migration Update all docs links to point to new Starlight structure: - docs/quick-start.md → docs/src/content/docs/reference/quick-start.md - docs/concepts.md → docs/src/content/docs/reference/concepts.md - docs/samples.md → docs/src/content/docs/reference/samples.md - docs/index.md → docs/src/content/docs/index.mdx Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> Co-authored-by: Peli de Halleux <pelikhan@users.noreply.github.com>
|
@copilot update the docs/src/contents/docs markdown file and remove the level 1 header since it is already in the frontmatter and rendered by astro. |
| with: | ||
| path: ./docs/dist | ||
|
|
||
| deploy: |
There was a problem hiding this comment.
only deploy if the event is workflow_dispatch or release
| name: Deploy Documentation to GitHub Pages | ||
|
|
||
| on: | ||
| workflow_dispatch: |
There was a problem hiding this comment.
@copilot also trigger on push with paths docs/**
.github/workflows/docs.yml
Outdated
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" |
|
@copilot apply review comments |
Migrating docs to starlight.