agentleFS
poingstudiospoingstudios/godot-admob-plugin/.agents/skills/doc-master/SKILL.md

doc-master

Skill648 starsChanged 3 months agoMITView on GitHub

Synchronize documentation with code changes. Use when modifying APIs, installation steps, or project requirements to ensure MkDocs, README, and AGENTS.md are accurate.

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 1

    1. jagdish31502/agent-skills★ 2same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository5 other files it gives its agents.

The file

Show its rules and text

We split this skill into the rules it gives an agent

14 rules. About 0 are common, 3 are distinctive, and 11 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 11

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep all project documentation in sync with the codebase.

    line 8
  2. Very specific:

    Static Navigation: All navigation structures must be defined statically in the nav block of mkdocs.yml.

    line 13
  3. Very specific:

    New Ad Format / Page: Create the new .md file in the appropriate directory, add it to the nav section in mkdocs.yml, and add its …

    line 14
  4. Very specific:

    API Change: Update the code blocks in the relevant docs/ files for both GDScript and C#.

    line 15
  5. Very specific:

    Class Links: When referencing plugin classes, resources, or enums (e.g.

    line 16
  6. Very specific:

    Requirement Change: If a plugin becomes mandatory/optional, update AGENTS.md and the error description files in docs/errors/.

    line 17
  7. Very specific:

    Release Assets: If the release filename pattern changes in release_matrix.yml, update the "Manual Installation" section in README.md.

    line 20
  8. Very specific:

    Ensure Android and iOS setup steps are verified when a new dependency is added to build.gradle or Package.swift.

    line 23
  9. Very specific:

    SDK Version Changes: When the Google Mobile Ads SDK or UMP version changes in Android Gradle or iOS Swift Package Manager configurations, …

    line 24
  10. Very specific:

    Custom Overrides: When adding support for a new locale, always define the translations for the announcement header banner and footer …

    line 30
  11. Very specific:

    Synchronous Updates: When adding new features, sections, or correcting code examples in the default .md files, also apply the same updates …

    line 31
  12. Distinctive:

    Never commit code changes without checking if they impact the documentation.

    line 38
  13. Distinctive:

    Ensure translated documentation files have 1:1 structural parity with their English counterparts.

    line 40
  14. Very specific:

    Continuous Improvement: When finding any new documentation pattern, improvement, or layout requirement, update this SKILL.md immediately …

    line 41

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

AdMob Doc Master Protocol

Keep all project documentation in sync with the codebase.

📝 Sync Requirements

1. Code to Docs & Navigation

  • Static Navigation: All navigation structures must be defined statically in the nav block of mkdocs.yml. Avoid using .pages files to prevent plugin conflicts and 404 routing errors during i18n compilation.
  • New Ad Format / Page: Create the new .md file in the appropriate directory, add it to the nav section in mkdocs.yml, and add its translation key to nav_translations for each language.
  • API Change: Update the code blocks in the relevant docs/ files for both GDScript and C#.
  • Class Links: When referencing plugin classes, resources, or enums (e.g. AdPosition, AdSize, AdView), always link them to their corresponding documentation in reference/classes/<ClassName>.md or reference/enums/<EnumName>.md to maintain documentation connectivity.
  • Requirement Change: If a plugin becomes mandatory/optional, update AGENTS.md and the error description files in docs/errors/.

2. Manual Installation

  • Release Assets: If the release filename pattern changes in release_matrix.yml, update the "Manual Installation" section in README.md.

3. Cross-Platform Docs

  • Ensure Android and iOS setup steps are verified when a new dependency is added to build.gradle or Package.swift.
  • SDK Version Changes: When the Google Mobile Ads SDK or UMP version changes in Android Gradle or iOS Swift Package Manager configurations, you must update these version numbers in the Native SDK Versions list in docs/index.md (and all its localization files) and AGENTS.md.

4. Localization Parity

  • Primary Source: English (en) is the source of truth. All new pages and layout changes must start in English first before translating.
  • Supported Locales: The current target locales are English (en), Brazilian Portuguese (pt-BR), Spanish (es), Simplified Chinese (zh), and Japanese (ja).
  • 1:1 Structure: Any localized/translated documentation page (e.g., .pt-BR.md, .es.md, .zh.md, .ja.md) MUST have the exact same headings, content structure, code blocks, anchors, and internal layout as the default English page.
  • Custom Overrides: When adding support for a new locale, always define the translations for the announcement header banner and footer copyrights in docs/overrides/partials/translations.html.
  • Synchronous Updates: When adding new features, sections, or correcting code examples in the default .md files, also apply the same updates immediately to all translated files of that page.

🛠️ Documentation Tools

  • Build Docs: mkdocs build
  • Serve Docs: mkdocs serve (check for broken links and formatting).

🚫 Workflow Rules

  • Never commit code changes without checking if they impact the documentation.
  • Prioritize updating the README.md for any breaking installation changes.
  • Ensure translated documentation files have 1:1 structural parity with their English counterparts.
  • Continuous Improvement: When finding any new documentation pattern, improvement, or layout requirement, update this SKILL.md immediately with the new findings to keep all developers and AI agents aligned.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.