{"id":21082766,"url":"https://github.com/renproject/ren-client-docs","last_synced_at":"2025-08-26T14:30:17.913Z","repository":{"id":45869360,"uuid":"355016546","full_name":"renproject/ren-client-docs","owner":"renproject","description":"Docs for interacting with Ren and RenVM","archived":false,"fork":false,"pushed_at":"2022-11-02T04:27:54.000Z","size":77264,"stargazers_count":1,"open_issues_count":0,"forks_count":8,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-14T02:52:02.844Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://renproject.github.io/ren-client-docs","language":"TypeScript","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/renproject.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}},"created_at":"2021-04-06T01:06:47.000Z","updated_at":"2023-04-20T20:08:16.000Z","dependencies_parsed_at":"2023-01-20T20:17:52.958Z","dependency_job_id":null,"html_url":"https://github.com/renproject/ren-client-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/renproject/ren-client-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-client-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-client-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-client-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-client-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renproject","download_url":"https://codeload.github.com/renproject/ren-client-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-client-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272229253,"owners_count":24895952,"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","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-19T20:15:15.268Z","updated_at":"2025-08-26T14:30:17.892Z","avatar_url":"https://github.com/renproject.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Website\n\nThis website is built using [Docusaurus 2](https://v2.docusaurus.io/).\n\n## Local Development\n\nTo start a development server:\n\n```shell\nyarn\nnpx docusaurus graphql-to-doc\nyarn start\n```\n\nTo build:\n\n```shell\nyarn build\n```\n\nTo deploy:\n\n\n```shell\nyarn deploy\n```\n\n## Adding deployments for a new chain or asset\n\n1. Update the `gateway-sol` submodule:\n\n```shell\ngit submodule update --init --recursive\n```\n\n2. Add any new chains to the table in deployments.mdx and add its explorers in `RenderGatewaySolConfig.tsx`. For new assets, add the icons to contracts/icons and then list the asset in `RenderGatewaySolConfig.tsx`\n\n\n\n\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n\n\n\n\n\n# Updating auto-generated docs\n\n## Contract Reference Types\n\nThe contract types are manually moved built and moved in from the contract repos. Assuming `gateway-sol`, `darknode-sol` and `ren-client-docs` are all in the same directory, then the following steps will update these docs:\n\n```shell\ncd ../gateway-sol\n\nyarn docs \u0026\u0026 rm -rf ../docs/ren-client-docs/contracts/gateway-sol \u0026\u0026 mv docs ../docs/ren-client-docs/contracts/gateway-sol\n\ncd ../darknode-sol\n\nyarn docs \u0026\u0026 rm -rf ../docs/ren-client-docs/contracts/darknode-sol \u0026\u0026 mv docs ../docs/ren-client-docs/contracts/darknode-sol\n\ncd ../ren-client-docs\n```\n\nIf contracts have been moved around or renamed or added/deleted, then the sidebar in `sidebarsContracts.js` should be updated.\n\n\u003chr /\u003e\n\n## JSON-RPC\n\nThe JSON-RPC docs are automatically generated from the OpenAPI spec in `./tools/json-rpc.json`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenproject%2Fren-client-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenproject%2Fren-client-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenproject%2Fren-client-docs/lists"}