{"id":19901946,"url":"https://github.com/hyperledger/indy-docs","last_synced_at":"2025-05-02T23:32:07.859Z","repository":{"id":147563380,"uuid":"163895292","full_name":"hyperledger/indy-docs","owner":"hyperledger","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-03T23:15:30.000Z","size":25,"stargazers_count":3,"open_issues_count":0,"forks_count":8,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-05-01T09:05:26.032Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://wiki.hyperledger.org/display/indy","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperledger.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-01-02T22:16:02.000Z","updated_at":"2024-01-25T06:12:43.000Z","dependencies_parsed_at":"2023-05-24T08:30:46.119Z","dependency_job_id":null,"html_url":"https://github.com/hyperledger/indy-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Findy-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Findy-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Findy-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Findy-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperledger","download_url":"https://codeload.github.com/hyperledger/indy-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252122304,"owners_count":21698305,"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","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-12T20:16:42.184Z","updated_at":"2025-05-02T23:32:07.482Z","avatar_url":"https://github.com/hyperledger.png","language":"Python","readme":"# Documentation README\nCheck out the indy docs at http://hyperledger-indy.readthedocs.io/\n\nLearn more about how our docs are built and maintained at http://hyperledger-indy.readthedocs.io/en/latest/docs.html\n\n## How to Add Documentation\nFor new features and pull requests, maintainers should make sure that the **contributor has added an explanation for their changes in the docs folder before merging the PR.**\n  \nContributors should write an addition to a current file or add a new file to the docs/source/ folder that explains what their feature is and how it works. If needed, they may also add a link to more technical README's located nearer to the code.\n\nWhenever additions are made to the docs, make sure to update the `index.rst` in whichever folder the file has been added, and build the docs locally to confirm they work (TODO: add the `sphinx-build` command to our CI/CD flow).\n\nFor example, if I wanted to add another file to the indy-sdk docs/ folder named `glossary.md`, I would create the file, and then add a reference to it in the `index.rst`: \n```\n.. toctree::\n  :maxdepth: 1\n  :hidden:\n\n  getting-started/index.rst\n  ...\n  other files\n  ...\n  glossary.md                   .. \u003c-- this is your new file!\n\n```\n\nTo add a new file to a subfolder, simply update the subfolder's `index.rst` with the relative link to your file.\n\nIf you'd like to link to a file outside of the docs/ folder, you'll need to provide an external github link (this is by design, to keep our docs organized into a single folder)\n\n\n## Building the docs on your machine\n\nHere are the quick steps to achieve this on a local machine without depending on ReadTheDocs. Note: Instructions may differ depending on your OS.\nRun these commands within the repository folder\n```bash\npip install Sphinx\npip install sphinx_rtd_theme\npip install recommonmark==0.4.0\ncd docs/source # Be in this directory. Makefile sits there.\nmake html\n```\n\nThis will generate all the html files in `docs/source/_build/html` which you can then browse locally in your browser. Every time you make a change to the documentation you will need to rerun `make html`.\n\n## Additional Instructions\nThis section is to be used for repo maintainers to add additional documentation guidelines or instructions. ","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger%2Findy-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperledger%2Findy-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger%2Findy-docs/lists"}