{"id":20675598,"url":"https://github.com/bitwarden/contributing-docs","last_synced_at":"2025-04-19T20:34:08.893Z","repository":{"id":64432623,"uuid":"561912610","full_name":"bitwarden/contributing-docs","owner":"bitwarden","description":"Contributing documentation","archived":false,"fork":false,"pushed_at":"2025-04-14T01:07:19.000Z","size":8815,"stargazers_count":33,"open_issues_count":24,"forks_count":18,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-04-14T02:23:44.081Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://contributing.bitwarden.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitwarden.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-11-04T19:28:08.000Z","updated_at":"2025-04-10T11:06:56.000Z","dependencies_parsed_at":"2024-04-15T07:01:10.490Z","dependency_job_id":"db655191-3e7f-485a-9069-66779d76556a","html_url":"https://github.com/bitwarden/contributing-docs","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/bitwarden%2Fcontributing-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwarden%2Fcontributing-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwarden%2Fcontributing-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwarden%2Fcontributing-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitwarden","download_url":"https://codeload.github.com/bitwarden/contributing-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249794892,"owners_count":21326776,"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-16T21:09:56.915Z","updated_at":"2025-04-19T20:34:08.874Z","avatar_url":"https://github.com/bitwarden.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bitwarden Contributing Docs\n\nThis repository contains the code for the\n[Bitwarden contributing docs](https://contributing.bitwarden.com/) site. The site is built using\n[Docusaurus](https://docusaurus.io/) which is a static website generator. The latest version of the\ndocumentation is available at https://contributing.bitwarden.com/.\n\n## Install\n\n```bash\nnpm ci\n```\n\n## Local Development\n\n```bash\nnpm start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are\nreflected live without having to restart the server.\n\n### SSL\n\nBy default, `npm start` will attempt to start your local instance with SSL enabled using\ncertificates referenced in your local dotfile (`.env`).\n\n- copy the provided `.env.example` to `.env` and update the values as needed\n- (requires [OpenSSL](https://www.openssl.org/)) Generate your self-signed certs with\n  `npm run setup:ssl` and follow the instructions.\n  - Alternatively use [mkcert](https://github.com/FiloSottile/mkcert) to\n    [generate and add certs to your trust store](https://docusaurus.io/docs/cli#enabling-https)\n- run `npm start`!\n\nIf the script fails to find your `.env` or the required values within, docusaurus will start\nnormally without SSL.\n\nIf you need to explicitly develop without SSL, simply delete your `.env` file or use the command\n`npm start:insecure` instead.\n\n## Build\n\n```bash\nnpm run build\n```\n\nThis command generates static content into the `build` directory and can be served using any static\ncontents hosting service.\n\n## Writing\n\nThe documentation is written in Markdown and can be found in the `docs` directory. The `docs`\ndirectory consists of three sections:\n\n- Getting started - instructions on how to build and run the different projects.\n- Contribute - information on how to contribute to the project.\n- Architecture - high-level architecture documentation.\n\n### Style guide\n\nPlease follow the following (very brief) style guide:\n\n- Use numbered paragraphs for all instructions or procedures. Start each paragraph with a verb\n  (“click”, “type”, “restart”, etc).\n- Use code blocks for all commands. Don't write them in-line.\n- Avoid long paragraphs - this documentation should be to-the-point and instructional.\n\n### Spellchecker\n\nWe use `cspell` for spellchecking. It will run as a pre-commit hook and in the CI pipeline.\nSpellchecking ignores single and multi-line code snippets. If required, you can add custom words\n(e.g. proper nouns and technical terms) to `custom-words.txt`.\n\n### Conditional Content\n\nThe Contributing Docs site is used both for internal and external contributors. To this end we've\nfacilitated a mean to conditionally show content for either group. This is primarily to keep the\nexternal docs simple.\n\nAs an end user you can switch the mode using the dropdown in the navigation bar. This will persist\nacross sessions.\n\n![Context switcher](.github/dropdown.png)\n\nIn order to write content that targets different context please use the `\u003cCommunity\u003e` and\n`\u003cBitwarden\u003e` tags as demonstrated below.\n\n```md\n\u003cCommunity\u003e\n\nThis content is shown only to community contributors.\n\n\u003c/Community\u003e\n\n\u003cBitwarden\u003e\n\nThis content is shown only to bitwarden contributors.\n\n\u003c/Bitwarden\u003e\n```\n\nThe technical implementation uses a custom context called `devMode` which is persisted to local\nstorage, and is exposed as a dropdown in the navigation bar.\n\nIt's also possible to conditionally hide pages from the navigation using `frontMatter`. This is\neasiest done using the `access` property, which can be either `community` or `bitwarden`.\n\n```yml\n---\nsidebar_custom_props:\n  access: bitwarden\n---\n```\n\n# License\n\nDocumentation (`docs` folder) is [Creative Commons BY-NC-ND licensed](./LICENSE_CC.txt).\n\nCode is [GPL licensed](./LICENSE_GPL.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitwarden%2Fcontributing-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitwarden%2Fcontributing-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitwarden%2Fcontributing-docs/lists"}