Skip to content

chore: gitignore the API reference#950

Merged
msluszniak merged 2 commits intomainfrom
@chmjkb/gitignore-autogenerated-docs
Mar 10, 2026
Merged

chore: gitignore the API reference#950
msluszniak merged 2 commits intomainfrom
@chmjkb/gitignore-autogenerated-docs

Conversation

@chmjkb
Copy link
Collaborator

@chmjkb chmjkb commented Mar 10, 2026

Description

The generated API reference under docs/docs/06-api-reference/ is regenerated at build time by docusaurus-plugin-typedoc (runs as part of yarn build), so there's no reason to track it in git. This removes the files, gitignores the directory, and deletes the now-redundant api-reference-up-to-date-check CI workflow.

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Tested on

  • iOS
  • Android

Testing instructions

Screenshots

Related issues

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

@chmjkb chmjkb marked this pull request as ready for review March 10, 2026 15:14
@msluszniak msluszniak added the chore PRs that are chores label Mar 10, 2026
@msluszniak msluszniak merged commit a3f0cf9 into main Mar 10, 2026
3 checks passed
@msluszniak msluszniak deleted the @chmjkb/gitignore-autogenerated-docs branch March 10, 2026 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore PRs that are chores

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants