{"id":21538390,"url":"https://github.com/rarimo/docs","last_synced_at":"2025-03-17T20:48:30.522Z","repository":{"id":211361873,"uuid":"728175509","full_name":"rarimo/docs","owner":"rarimo","description":"Rarimo Developer Portal","archived":false,"fork":false,"pushed_at":"2024-04-12T09:31:56.000Z","size":62735,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-13T20:51:11.482Z","etag":null,"topics":["developer-tools","documentation","guides","tutorial"],"latest_commit_sha":null,"homepage":"https://docs.rarimo.com","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rarimo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-12-06T11:44:54.000Z","updated_at":"2024-04-15T13:49:43.780Z","dependencies_parsed_at":"2024-03-04T13:43:28.765Z","dependency_job_id":"5e9cc14d-6ef1-45a8-a2c0-948d309164f4","html_url":"https://github.com/rarimo/docs","commit_stats":null,"previous_names":["rarimo/docs"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rarimo","download_url":"https://codeload.github.com/rarimo/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244110091,"owners_count":20399562,"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":["developer-tools","documentation","guides","tutorial"],"created_at":"2024-11-24T04:11:48.819Z","updated_at":"2025-03-17T20:48:30.494Z","avatar_url":"https://github.com/rarimo.png","language":"CSS","readme":"# Rarimo Developer Portal\n\n[Developer Portal](https://docs.rarimo.com/) contains technical documentation for all things Rarimo.\nThis website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator\n\n## Development\n\n### Installation\n\n```sh\nyarn\n```\n\n### Local Development\n\n```sh\nyarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Testing\n\n```sh\nyarn typecheck\nyarn lint\n```\n\nThis does a quick typecheck / lint. We don't have any formal tests (yet) for this repo.\n\n### Build\n\n```sh\nyarn build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n## Style Guide\n\nThe [Divio Documentation System](https://documentation.divio.com/) principles were adopted to keep the docs comprehensive and manageable. In a nutshell, every document falls into one of the four categories:\n\n- High-level explanation docs;\n- Tutorials(learning-oriented guides);\n- How-to-guides(problem-oriented guides);\n- Reference;\n\nDocuments in each category have a different purpose and require a different approach to writing them.\n\n![Divio Documentation System](https://documentation.divio.com/_images/overview.png)\n\n\u003c!-- Add writing style recommendations --\u003e\n\n## Contributing\n\nWe welcome contributions from the community! To contribute to this project, follow these steps:\n\n1. Fork the repository.\n1. Create a new branch with a descriptive name for your feature or bug fix.\n1. Make your changes and commit them.\n1. Push your changes to your branch on your GitHub fork.\n1. Create a pull request from your branch to the `main` branch of this repository.\n\nPlease ensure your pull request adheres to the following guidelines:\n\n- Add a clear pull request title;\n- Add a comprehensive pull request description that includes the motivation behind the changes, steps needed to test them, etc;\n- Update the CHANGELOG.md accordingly;\n- Keep the codebase clean and well-documented;\n- Make sure your code is properly tested;\n- Reference any related issues in your pull request;\n\nThe maintainers will review your pull request and may request changes or provide feedback before merging. We appreciate your contributions!\n\n## Changelog\n\nFor the changelog, see [CHANGELOG.md](CHANGELOG).\n\n## License\n\nThis project is under the MIT License - see the [LICENSE](LICENSE) file for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frarimo%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frarimo%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frarimo%2Fdocs/lists"}