{"id":14111274,"url":"https://github.com/getsolus/help-center-docs","last_synced_at":"2026-01-28T01:20:25.911Z","repository":{"id":3421828,"uuid":"49415301","full_name":"getsolus/help-center-docs","owner":"getsolus","description":"Solus's Help Center documentation as well as previous User Guide.","archived":false,"fork":false,"pushed_at":"2026-01-10T22:41:20.000Z","size":186490,"stargazers_count":57,"open_issues_count":50,"forks_count":89,"subscribers_count":12,"default_branch":"master","last_synced_at":"2026-01-11T06:52:30.413Z","etag":null,"topics":["documentation","hacktoberfest","help-center","solus","user-guide"],"latest_commit_sha":null,"homepage":"https://help.getsol.us","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getsolus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MD.txt","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-01-11T09:23:04.000Z","updated_at":"2026-01-10T22:40:16.000Z","dependencies_parsed_at":"2025-10-07T01:23:32.569Z","dependency_job_id":null,"html_url":"https://github.com/getsolus/help-center-docs","commit_stats":{"total_commits":757,"total_committers":96,"mean_commits":7.885416666666667,"dds":0.7424042272126816,"last_synced_commit":"0cfdd5b1ebfc666708e32d564140c8800b32cadf"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/getsolus/help-center-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsolus%2Fhelp-center-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsolus%2Fhelp-center-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsolus%2Fhelp-center-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsolus%2Fhelp-center-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getsolus","download_url":"https://codeload.github.com/getsolus/help-center-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getsolus%2Fhelp-center-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28831250,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T23:29:49.665Z","status":"ssl_error","status_checked_at":"2026-01-27T23:25:58.379Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","hacktoberfest","help-center","solus","user-guide"],"created_at":"2024-08-14T10:03:13.649Z","updated_at":"2026-01-28T01:20:25.897Z","avatar_url":"https://github.com/getsolus.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://getsol.us\"\u003e\n    \u003cimg src=\"https://getsol.us/imgs/logo.png\" alt=\"Solus logo\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# Help Center documentation\n\nThis is the repository for Solus's [Help Center](https://help.getsol.us/) documentation. You can help us improve the Solus experience by:\n\n- Contributing documentation on new topics.\n- Editing existing documentation for formatting, spelling and punctuation, and conformance with our [style guide](https://help.getsol.us/docs/user/contributing/style).\n- Working on fixes for [existing issues](https://github.com/getsolus/help-center-docs/issues).\n- Identifying and reporting new issues.\n\n## Getting started\n\nTo get started developing our Docusaurus instance, or writing documentation, first [fork this project](https://github.com/getsolus/help-center-docs/fork) so you can submit pull requests for your changes.\n\nThis project is written using [TypeScript](https://www.typescriptlang.org) and [React](https://reactjs.org), with content written in Markdown or [MDX](https://mdxjs.com/). To facilitate development, we use `nvm` and `yarn`.\n\nPlease lint and spellcheck your contributions before creating a pull request. We recommend VS Code with the \"prettier\" extension for linting, and [Code Spell Checker](https://cspell.org/) (`cspell`) for spelling.\n\n### Content formatting and spelling\n\n- Writing style should follow our [style guide](https://help.getsol.us/docs/user/contributing/style)\n- This project includes `prettier` for markdown and code formatting\n  - Command: `go-task lint`\n- This project includes Cspell for spell-checking, and has a custom wordlist `.cspell-allowed-wordlist.txt`\n  - Command: `go-task spellcheck`\n  - Note that we use American spelling\n  - If you use vscode with the Code Spell Checker extension, the custom dictionary will be used\n  - You can tidy the allowed-wordlist with `go-task tidy-words`\n\n### NVM\n\nTo set up `nvm`, the Node Version Manager, follow the instructions listed [here](https://github.com/nvm-sh/nvm#readme). We recommend [setting up their shell integration](https://github.com/nvm-sh/nvm#deeper-shell-integration) as well, so you can automatically switch to the correct Node version when working on this project. Otherwise, ensure you run `nvm use`. This project requires the \"current\" supported release series of Node.\n\nYou can validate you are using the latest by running `node --version`. Your version should be at least 19.x.\n\n### Yarn\n\nThis project makes use of [Yarn](https://yarnpkg.com/) for its package management. After setting up nvm and ensuring you are running the latest Node, run:\n\n```\ncorepack enable\n```\n\n### Installing dependencies\n\nTo install the required dependencies, run: `yarn`\n\n### Starting Docusaurus\n\nTo start the live reloading Docusaurus, run: `yarn start`\n\n### Other useful commands\n\n- Clear local build cache: `yarn clear`\n- Linting: `yarn lint`\n- Updating translation files: `yarn write-translations`\n- Validate build: `yarn build`\n- Run validated build: `yarn serve`\n\n## Publishing to https://help.getsol.us (via GH Pages)\n\nEnsure that you can successfully generate a static site as above.\n\nThen, when you're ready to deploy, run the following:\n\n`go-task deploy`\n\nThis obviously assumes that you have ssh push access to the `help-center-docs` repository and are using `remote.origin.url=git@github.com:getsolus/help-center-docs.git` (as listed by `git config -l`).\n\n## Contributing\n\n### Multi-lingual documents\n\nNote that multi-lingual documents are not yet supported on our Help Center. When it does, we'll be happy to accept non-English language documents.\n\n## Licenses\n\n### Build system\n\nFiles relating to the parsing / build system are licensed under GPL-2.0. For the full text, view LICENSE.txt.\n\n### Markdown\n\nThe Markdown files in this repository are licensed under the Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works.\n\n### Media assets\n\n- Solus logo copyright and licensing information is provided on our [Brand Guidelines page](https://getsol.us/branding).\n- Non-logo assets are licensed under Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetsolus%2Fhelp-center-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetsolus%2Fhelp-center-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetsolus%2Fhelp-center-docs/lists"}