{"id":44292828,"url":"https://github.com/logos-messaging/docs.waku.org","last_synced_at":"2026-02-11T00:06:14.189Z","repository":{"id":50440436,"uuid":"519094785","full_name":"logos-messaging/docs.waku.org","owner":"logos-messaging","description":"Waku Documentation Portal","archived":false,"fork":false,"pushed_at":"2026-02-05T15:07:21.000Z","size":50194,"stargazers_count":5,"open_issues_count":20,"forks_count":8,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2026-02-06T01:37:54.162Z","etag":null,"topics":["documentation","waku","website"],"latest_commit_sha":null,"homepage":"https://docs.waku.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/logos-messaging.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":"docs/security.md","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":"2022-07-29T05:45:58.000Z","updated_at":"2026-02-05T15:10:36.000Z","dependencies_parsed_at":"2023-09-26T16:22:51.567Z","dependency_job_id":"2b8eb41a-1977-43bc-b1e0-0f380890b8e3","html_url":"https://github.com/logos-messaging/docs.waku.org","commit_stats":null,"previous_names":["waku-org/docs.waku.org"],"tags_count":0,"template":false,"template_full_name":"acid-info/logos-sites-content-repo-template","purl":"pkg:github/logos-messaging/docs.waku.org","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logos-messaging%2Fdocs.waku.org","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logos-messaging%2Fdocs.waku.org/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logos-messaging%2Fdocs.waku.org/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logos-messaging%2Fdocs.waku.org/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/logos-messaging","download_url":"https://codeload.github.com/logos-messaging/docs.waku.org/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logos-messaging%2Fdocs.waku.org/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29322738,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-10T20:44:44.282Z","status":"ssl_error","status_checked_at":"2026-02-10T20:44:43.393Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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","waku","website"],"created_at":"2026-02-11T00:06:13.375Z","updated_at":"2026-02-11T00:06:14.178Z","avatar_url":"https://github.com/logos-messaging.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Waku Documentation Portal\n\n[![Waku Documentation Portal](https://img.shields.io/badge/docs.waku.org-black)](https://docs.waku.org/)\n\nThe Waku Documentation Portal can be accessed at [https://docs.waku.org/](https://docs.waku.org/) and was built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.\n\n## Prerequisites\n\n- [Node.js](https://nodejs.org/en/)\n- [yarn](https://yarnpkg.com/en/)\n\n## Installation\n\nClone this repository:\n\n```shell\ngit clone https://github.com/waku-org/docs.waku.org\n```\n\nInstall the dependencies:\n\n```shell\nyarn\n\n# or\n\nyarn install\n```\n\n## Running Locally\n\n```shell\nyarn start # Run 'node fetch-content.js' in the root directory to fetch remote files\n```\n\nCheck for spelling errors before deploying:\n\n```shell\nyarn check:spell\n```\n\nCreate a production build locally to check for errors:\n\n```shell\nyarn build # Runs 'node fetch-content.js' and then 'docusaurus build'\n# The 'fetch-content.js' script fetches documents from the nwaku and research repositories.\n\n# test the build\nyarn serve\n```\n\n## Configuration\n\nEdit the `docusaurus.config.js` file located in the repository's root directory, and update the `businessUnit` field within the presets section. Here is a list of valid values for this field:\n\n- Logos\n- Codex\n- Waku\n\nExample:\n\n```js\npresets: [\n  [\n    '@acid-info/logos-docusaurus-preset',\n    {\n      businessUnit: 'Waku',\n    },\n  ],\n],\n```\n\nThis should suffice since Logos plugins will handle other configurations linked to the designated business unit. However, if you encounter any inaccuracies in the data provided by Logos Plugins, please visit the [Logos Docusaurus Plugins](https://github.com/acid-info/logos-docusaurus-plugins) page and submit an issue.\n\n## Customisation\n\nYou can find the instructions on adding more documentation sections, localisation, and versioning on the [Docusaurus](https://docusaurus.io/docs) website.\n\n\u003e Note that theme customisation is limited; for further instructions on customizing your theme, head over to [Logos Docusaurus Theme](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/).\n\n## Troubleshooting\n\nDocusaurus depends heavily on caching to enhance site performance. If you make changes that do not appear in the portal, try clearing the cache by running:\n\n```shell\nyarn clear\n```\n\n## CI/CD\n\n- [CI builds](https://ci.infra.status.im/job/website/job/docs.waku.org/) `master` and pushes to `deploy-master` branch, which is hosted at [https://docs.waku.org/](https://docs.waku.org/).\n- [CI builds](https://ci.infra.status.im/job/website/job/dev-docs.waku.org/) `develop` and pushes to `deploy-develop` branch, which is hosted at [https://dev-docs.waku.org/](https://dev-docs.waku.org/).\n\nThe hosting is done using [Caddy server with Git plugin for handling GitHub webhooks](https://github.com/status-im/infra-misc/blob/master/ansible/roles/caddy-git).\n\nInformation about deployed build can be also found in `/build.json` available on the website.\n\n## Change Process\n\n1. Create a new working branch from develop: git checkout develop; git checkout -b my-changes.\n2. Make your changes, push them to the origin, and open a Pull Request against the develop branch.\n3. After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).\n4. When ready to promote changes to the live website, rebase the master branch on the staging changes: git checkout master; git pull origin master; git rebase origin/develop; git push.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogos-messaging%2Fdocs.waku.org","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flogos-messaging%2Fdocs.waku.org","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogos-messaging%2Fdocs.waku.org/lists"}