Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 21, 2025

The README builder generated non-functional anchor links using file paths (e.g., #.github/workflows/Package-Publish.yml) and lacked usage examples.

Changes

  • Created toAnchorId() utility - Converts text to markdown-compliant anchor IDs (lowercase, special chars → hyphens)
  • Fixed glossary links - Use toAnchorId(name) instead of raw file paths
  • Fixed item headers - Match glossary anchors using same transformation
  • Added example usage - Generate functional YAML examples for workflows and actions
    • Workflows: Complete job definition with uses and with blocks
    • Actions: Step definition with proper input syntax
    • Values: Defaults when available, else GitHub Actions expressions (${{ secrets.EXAMPLE_* }})

Example

Before:

#### [Node Package Publish](#.github/workflows/Package-Publish.yml)

After:

#### [Node Package Publish](#node-package-publish)

**Example Usage:**

    name: Example Workflow
    on:
      push:
        branches: [main]
    
    jobs:
      example:
        uses: Bracketed/Workflows/.github/workflows/Package-Publish.yml@main
        with:
          project-name: @${{ github.repository }}
          repository-owner: bracketed
          node-version: 23
Original prompt

Fix the anchor links in the readme builder so they work, and add in example usage to the builders so the readme is populated with functional and high quality data and design


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits November 21, 2025 13:28
Co-authored-by: ninjaninja140 <88348015+ninjaninja140@users.noreply.github.com>
Co-authored-by: ninjaninja140 <88348015+ninjaninja140@users.noreply.github.com>
@ninjaninja140 ninjaninja140 marked this pull request as ready for review November 21, 2025 13:36
@ninjaninja140 ninjaninja140 self-requested a review as a code owner November 21, 2025 13:36
Copilot AI changed the title [WIP] Fix anchor links in README builder and add example usage Fix anchor link generation and add example usage to README builder Nov 21, 2025
@ninjaninja140 ninjaninja140 merged commit a707ac8 into main Nov 21, 2025
1 of 2 checks passed
@ninjaninja140 ninjaninja140 deleted the copilot/fix-anchor-links-readme-builder branch November 21, 2025 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants