{"id":37533709,"url":"https://github.com/tributech-solutions/tributech-docs","last_synced_at":"2026-01-16T08:35:40.278Z","repository":{"id":37422016,"uuid":"288283560","full_name":"tributech-solutions/tributech-docs","owner":"tributech-solutions","description":"Tributech Platform Documentation","archived":false,"fork":false,"pushed_at":"2025-07-15T11:03:52.000Z","size":138082,"stargazers_count":10,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-15T20:55:42.053Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":"","language":"MDX","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/tributech-solutions.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,"zenodo":null}},"created_at":"2020-08-17T20:50:13.000Z","updated_at":"2025-07-15T11:02:44.000Z","dependencies_parsed_at":"2023-02-12T00:45:20.454Z","dependency_job_id":"85058654-e1e2-4736-8dbc-890eda7b7a81","html_url":"https://github.com/tributech-solutions/tributech-docs","commit_stats":null,"previous_names":["tributech-solutions/tributech-docs"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/tributech-solutions/tributech-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tributech-solutions%2Ftributech-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tributech-solutions%2Ftributech-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tributech-solutions%2Ftributech-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tributech-solutions%2Ftributech-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tributech-solutions","download_url":"https://codeload.github.com/tributech-solutions/tributech-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tributech-solutions%2Ftributech-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"last_error":"SSL_read: 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"],"created_at":"2026-01-16T08:35:39.555Z","updated_at":"2026-01-16T08:35:40.272Z","avatar_url":"https://github.com/tributech-solutions.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tributech Platform Documentation\n\n## ![Publish docs via GitHub Pages](https://github.com/tributech-solutions/tributech-DSK-docs/workflows/Publish%20docs%20via%20GitHub%20Pages/badge.svg?branch=master)\n\nThis repository contains the Tributech Platform documentation.\nThis documentation is written in markdown syntax using [docusaurus](https://docusaurus.io/docs/) hosted on Github Pages.\n\n## Why doesn't this repo use Git LFS?\n\nGit LFS is not supported with Github Pages: https://github.com/git-lfs/git-lfs/issues/3498\n\n## Requirements \nInstall NodeJS on [Windows](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows) or [WSL](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl), e.g. WSL:\n```\n## Install NodeJS on WSL\n\n# install curl\n$ sudo apt-get install curl\n\n# install nvm\n$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash\n\n# restart console\n\n# check if nvm is installed\n$ nvm --version\n\n# install Node.js max LTS version \u003c v18 (because of the Webpack crypto.createHash() function)\n$ nvm install 23.0.0\n```nvm install\n\n## Installation\n\n```console\nyarn\n```\n\n## Local Development\n\n```console\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```\nyarn clear\n```\n\nThis command clears the local cache in case References / Images are not reflected in the `yarn start`\n\n## Build\n\n```console\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## Deployment\n\nThe master branch get automatically deployed using Github-Actions.\n\n## Versioning\n\n### Updating a specific version\n\nTo update a specific version of the documentation just edit the files in the correct folder and merge to master using a PR.\n\n### Releasing a new version\n\nBy default, Docusaurus uses a `/docs` folder to store the \"latest version\" of the documentation, which appears in the version dropdown menu.\nHowever, in this setup, only numbered versions should be visible in the dropdown, so the `/docs` folder has been deleted.\n\nTo release a new version with Docusaurus using the command `yarn run docusaurus docs:version [X.X.X]`, follow these steps:\n\n1. Copy the latest version from versioned_docs into a newly created `/docs` folder at the root of the repository.\n2. Run the versioning command mentioned above to create the new version.\n3. After releasing the new version, you can delete the `/docs` folder again.\n4. Make any necessary changes for the new release in the corresponding folder inside `/versioned_docs`.\n\n## Add new Navbar items\n\nPreviously, the navbar was configured globally in `docusaurus.config.js`. Now, since different versions (e.g., v5.0.0 vs. earlier versions) require different navbar items, the navbar has been customized using a swizzled theme component.\n\n- **Global navbar items** (shared across all versions) should still be added to `docusaurus.config.js` under `themeConfig.navbar.items`.\n- **Version-specific or custom navbar items** should be added directly in the React component at `src/theme/Navbar/Content/index.js`.\n\nTo add a custom navbar item for a specific version:\n\n1. Open `src/theme/Navbar/Content/index.js`.\n2. Use the `activeVersion` variable to conditionally render your custom `\u003cLink\u003e` or navbar item for the desired version.\n3. Example:\n   ```jsx\n   {activeVersion?.name === '5.0.0' \u0026\u0026 (\n     \u003cLink className=\"navbar__item navbar__link\" to=\"/tributech_c_sdk/overview\"\u003e\n       Tributech C-SDK\n     \u003c/Link\u003e\n   )}\n   ```\n4. For items that should appear in multiple versions, adjust the condition accordingly.\n\n**Note:**\nGlobal items remain in the config; version-specific items are handled in the **swizzled** component.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftributech-solutions%2Ftributech-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftributech-solutions%2Ftributech-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftributech-solutions%2Ftributech-docs/lists"}