Skip to content

Conversation

@marcel-rbro
Copy link
Contributor

@marcel-rbro marcel-rbro commented Dec 16, 2025

Note

Adds .github/copilot-instructions.md detailing repo-specific context and writing guidelines for AI tools (OpenAPI pipeline, theme, patterns, QA, and style).

  • Docs:
    • New AI agent guide in .github/copilot-instructions.md providing:
      • Project overview & architecture: Docusaurus multi-repo setup, custom theme workspace.
      • OpenAPI build pipeline: source locations, Redocly plugins, build command, generated outputs.
      • Project patterns: OpenAPI code samples, slug collection, external link processing, LLMs.txt generation.
      • Quality & pitfalls: broken links, frontmatter, code block languages; local build, linting, OpenAPI validation.
      • Quick reference for common tasks and navigation updates.
      • Writing & style guidelines: frontmatter schema, naming, formatting, admonitions, terminology.
      • Content review checklist and doc type guidelines; related references (CONTRIBUTING.md, AGENTS.md).

Written by Cursor Bugbot for commit 8c34a1b. Configure here.

@apify-service-account
Copy link

Preview for this PR was built for commit 8c34a1ba and is ready at https://pr-2146.preview.docs.apify.com!

@marcel-rbro marcel-rbro changed the title Docs: Add GitHib copilot instruction files docs: Add GitHib copilot instruction files Dec 16, 2025
@apify-service-account
Copy link

Preview for this PR was built for commit 9cea7888 and is ready at https://pr-2146.preview.docs.apify.com!

@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Dec 17, 2025
@apify-service-account
Copy link

Preview for this PR was built for commit d48f9845 and is ready at https://pr-2146.preview.docs.apify.com!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants