πΈ Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Integration guide standard
Every page under content/docs/(docs)/guides/ follows TEMPLATE.mdx in this folder.
npm run lint:guides checks every guide against the rules below and runs in CI.
Rules
- Frontmatter:
titleis the platform name as the vendor spells it.descriptionisAdd Rybbit analytics to your <Platform> site(useapp,store,docs,blogwhen that is the better noun).categoryis one of the values inscripts/check-guides.mjs.iconis an@icons-pack/react-simple-iconsexport name (SiWordpress); omit it when the brand has no icon. - Skeleton: intro paragraph, then exactly three
<Step>s titledGet your tracking snippet,Add the snippet to <Platform>,Verify installation. Optional## Track custom eventsand## Troubleshooting, then## Next steps. - Shared content comes from partials, never retyped:
get-snippet.mdxβ the canonical snippet and the self-hosting note.verify.mdxβ the verification checklist.next-steps.mdxβ cross-links. Include with<include>../../../partials/guides/<name>.mdx</include>(one more../from a subfolder such asreact/). Includes are inlined at build time, so they also reach the.mdx/llms.txtendpoints that AI agents read.
- Snippet form: when a guide must show the tag inline (a template file, a config
value, a JS injector), use the URL form
script.js?siteId=YOUR_SITE_IDwithdefer. Never the legacydata-site-idattribute: script optimisers stripdata-*attributes. - Only platform-specific content belongs in the guide. Generic explanations of what Rybbit is, how events work, GDPR, ad blockers or proxies are linked, not repeated.
- Don't invent UI. Menu paths and file names must be real. If you cannot confirm where custom head code goes on a platform, say what the setting is usually called and point to the vendor's own page rather than guessing a path.
- Tone: second person, present tense, imperative steps. No "powerful", "seamless", "easily". A guide is typically 40β120 lines; length comes from real platform detail, not padding.
- Imports: double quotes,
StepsbeforeCalloutbeforeTabs, only what is used. - Sidebar: add the slug to
guides/meta.jsonunder the matching---Category---separator, alphabetically. The index page (guides/index.mdx) groups by frontmattercategoryautomatically.
Adding a guide
cp content/partials/guides/TEMPLATE.mdx "content/docs/(docs)/guides/<slug>.mdx"
# fill it in, then
npm run lint:guides