{"id":36912037,"url":"https://github.com/wisdom-oss/docs-tool","last_synced_at":"2026-01-12T15:59:42.106Z","repository":{"id":173327476,"uuid":"446490007","full_name":"wisdom-oss/docs-tool","owner":"wisdom-oss","description":"A tool set to fetch and unify documentation files from all repositories in the WISdoM OSS organization, simplifying documentation management.","archived":false,"fork":false,"pushed_at":"2024-08-21T12:51:28.000Z","size":370,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-21T14:19:18.667Z","etag":null,"topics":["documentation","docusaurus"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/wisdom-oss.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2022-01-10T16:02:05.000Z","updated_at":"2024-08-21T12:51:32.000Z","dependencies_parsed_at":"2024-08-21T14:18:15.951Z","dependency_job_id":"11f8707f-b6ee-433a-baae-b4815dc7fcb6","html_url":"https://github.com/wisdom-oss/docs-tool","commit_stats":null,"previous_names":["wisdom-oss/docs-tool"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wisdom-oss/docs-tool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisdom-oss%2Fdocs-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisdom-oss%2Fdocs-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisdom-oss%2Fdocs-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisdom-oss%2Fdocs-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wisdom-oss","download_url":"https://codeload.github.com/wisdom-oss/docs-tool/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisdom-oss%2Fdocs-tool/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28341906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T15:50:39.657Z","status":"ssl_error","status_checked_at":"2026-01-12T15:49:49.297Z","response_time":98,"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","docusaurus"],"created_at":"2026-01-12T15:59:41.838Z","updated_at":"2026-01-12T15:59:42.095Z","avatar_url":"https://github.com/wisdom-oss.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WISdoM OSS Docs-Tool\n\nThe WISdoM OSS Docs-Tool is a collection of tools and scripts used to generate \nand manage documentation for the WISdoM OSS organization. \nIt is designed to automatically fetch documentation files from all the \nrepositories in the organization, generate a unified dashboard for all the \ndocumentation, and update it as necessary.\n\n## Parts\n\nThe WISdoM OSS Docs-Tool consists of three parts:\n\n### [repos](repos/README.md)\n\nFetches information about all the repositories in the organization wisdom-oss on\nGitHub, and downloads all the documentation files from each repository's\nbranches.\nIt then constructs a configuration for Docusaurus plugins that will be used to\nbuild the final documentation website.\n\n### [docusaurus](docusaurus/README.md)\n\nThe main rendering tool for all the documentation that is part of the WISdoM OSS\norganization.\nIt uses [Docusaurus](https://docusaurus.io), a documentation tool created by \nFacebook, to generate documentation sites.\n\n### [admin](admin/README.md)\n\nA Node.js application that manages all the other components and serves as the\nmain entry point for the compiled documentation.\nIt supports authorized PUT requests to rebuild the entire documentation.\n\n## Environment Variables\n\nThe following environment variables are required to run the Docs-Tool:\n\n- `GITHUB_SECRET`: A personal access token for the GitHub API, used to fetch the \n  repositories and their documentation.\n\n- `ADMIN_SECRET`: The bearer token used to authorize the PUT `/admin.*` endpoint. \n  This is required for updating the documentation.\n\n## Dependencies\n- Node.js (\u003e= 14.0.0)\n- PNPM (\u003e= 7.3.0)\n- Caddy (\u003e= 2.4.5)\n\n## Installation\n\nTo install the WISdoM OSS Docs-Tool, clone the repository and install the \ndependencies using pnpm:\n\n```bash\ngit clone https://github.com/wisdom-oss/docs-tool.git\ncd docs-tool/\npnpm install\n```\n\n## Usage\n\n### Starting the Docs-Tool\n\nTo start the Docs-Tool, run the following command:\n\n```bash\npnpm start\n```\n\nThis will start the admin/ application, which will start the other components of \nthe docs-tool.\n\n### Updating the Documentation\n\nTo update the documentation, send an authorized PUT request to `/admin.*`, \nwhere * can be any path. \nThe Authorization header should contain a bearer token set to the value of the \n`ADMIN_SECRET` environment variable.\n\n### Accessing the Documentation\n\nOnce the docs-tool is running, you can access the documentation at \nhttp://localhost:3000. \nThis will take you to the main dashboard that lists all the repositories and \nbranches that have documentation available.\n\nClicking on a repository will take you to its documentation page, where you can \nswitch between branches using a custom dropdown in the top right corner. \nThe documentation page allows you to quickly navigate between the README, docs, \nand API (if available).\n\n## Deployment via Docker\nYou can use Docker to build a standalone container for the Docs-Tool. \nNote that this container is larger (1GB+) compared to other containers used in \nthe WISdoM OSS organization, as it requires several tools to rebuild parts of \nitself on demand.\n\nTo build the container, use the following command:\n\n```bash\ndocker build -t wisdom-oss/docs-tool:latest .\n```\n\nOnce the container is built, you can run it using:\n\n```bash\ndocker run -it --rm -p 3000:3000 -e GITHUB_SECRET=\u003cyour-token-here\u003e -e ADMIN_SECRET=\u003cyour-admin-secret-here\u003e wisdom-oss/docs-tool:latest\n```\n\nMake sure you set the necessary environment variables (`GITHUB_SECRET` and \n`ADMIN_SECRET`) for the container to function properly. \nAlso, bind the exposed port (3000) to interact with the container.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwisdom-oss%2Fdocs-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwisdom-oss%2Fdocs-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwisdom-oss%2Fdocs-tool/lists"}