{"id":20763786,"url":"https://github.com/revenuecat/revenuecat-content-guide","last_synced_at":"2026-03-12T12:31:16.219Z","repository":{"id":97862337,"uuid":"379365384","full_name":"RevenueCat/revenuecat-content-guide","owner":"RevenueCat","description":"The repository hold the Content Guide use for writing technical content  ","archived":false,"fork":false,"pushed_at":"2021-07-28T19:10:29.000Z","size":426,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-01-18T05:46:58.693Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RevenueCat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-22T18:28:01.000Z","updated_at":"2023-07-25T14:47:13.000Z","dependencies_parsed_at":"2023-07-06T20:00:21.301Z","dependency_job_id":null,"html_url":"https://github.com/RevenueCat/revenuecat-content-guide","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RevenueCat%2Frevenuecat-content-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RevenueCat%2Frevenuecat-content-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RevenueCat%2Frevenuecat-content-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RevenueCat%2Frevenuecat-content-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RevenueCat","download_url":"https://codeload.github.com/RevenueCat/revenuecat-content-guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243086246,"owners_count":20234004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T10:47:32.228Z","updated_at":"2025-12-16T10:25:44.221Z","avatar_url":"https://github.com/RevenueCat.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cdiv align='center'/\u003e Welcome to RevenueCat's Content Guide \n\nThis guide is predominantly for RevenueCat employees, but anyone can view how we communicate in our content. \n\n\n# How to Use Our Content Style Guide\n\nOur content style guide was created to create consistency with how we communicate in our documentation and through support. This document will serve as a place for how to utilize our content style guide. \n\nContent Style Guide Table of Contents\n\n- [Goals](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/01-goals.md)\n- [Voice and Tone](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/02-voice-and-tone.md)\n- [Grammar and Mechanics](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md)\n\n    [Links](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#links)\n\n    [Click vs Select](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#click-vs-select)\n\n    [Italics](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#italics)\n\n    [Bold](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#bold)\n\n    [Capitalization](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#capitalization)\n\n    [Code in Text](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#code-in-text)\n\n    [Contractions](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#contractions)\n\n    [Dates](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#dates)\n\n    [Exclamation Points](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#exclamation-points)\n\n    [Hyphens](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#hyphens)\n\n    [Numbers](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#numbers)\n\n    [Emojis](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#emojis)\n\n    [Writing About RevenueCat](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#writing-about-revenuecat)\n\n- [Creating Structured Content](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/04-creating-structured-content.md)\n\n## What is a Content Style Guide?\n\nA content style guide is a set of standards for writing and formatting our content. Her[e](http://content.Here) RevenueCat at one of our pillars is being customer-obsessed. One we display this is creating a consistent experience for all individuals coming to RevenueCat. We always want to stick true to our goals in our writing.   \n\n## When to Use Our Content Style Guide?\n\nOur content guide can be used for all facets in RevenueCat where we are communicating to our customers. We recommend reviewing the [goals](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/01-goals.md) and [voice and tone](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/02-voice-and-tone.md) guides before writing documentation. When editing documentation or any writing the content guide can be a source of truth formatting and grammar needs. We also have a section on how to create tables, lists, photos, etc to comply with our standards.   \n\n## Using our Content Style Guide\n\nWe have a quick checklist for editing documentation. Although this does not fully capture all areas of the content guide it highlights some key areas. \n\n### Content Check List\n\n- [ ]  Review the RevenueCat [Voice and Tone Guide](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/02-voice-and-tone.md)\n- [ ]  Titles are capitalized with [title case](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#headerstitles---title-case)\n- [ ]  Bold words/content are used for referring to UI elements or drawing emphasis\n- [ ]  'select' is used in any instances of 'click'\n- [ ]  Italicized words/content are used only for defining a word/phrase or referring to books, movies, and other full-length works.\n- [ ]  [Descriptive links](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#links) are used\n- [ ]  Tables, Lists, and Photos are properly structured based on our [guide](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/04-creating-structured-content.md)\n- [ ]  Urgent information has been separated into a [callout](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/04-creating-structured-content.md#callouts) ( for ReadMe docs )\n\n\n\n## Adding a File\n\nThe guide contains markdown files. When adding a new file, name your file without spaces and a `.md` or `.markdown` extension.\n\n\u003cbr/\u003e\n\nThe files in this guide are prefixed with a double-digit to set order. Make sure your file starts with a number that will place your new content in the desired position (e.g.: `02`-) and change the prefixes of the other files to reflect this change in order.\n\n\n## Managing Content \n\nWhen updating or adding content to our current pages, submit a pull request and add a reviewer. Please provide as much detail as you can when submitting your pull request. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevenuecat%2Frevenuecat-content-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevenuecat%2Frevenuecat-content-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevenuecat%2Frevenuecat-content-guide/lists"}