{"id":20060609,"url":"https://github.com/oasisprotocol/docs","last_synced_at":"2025-05-05T15:33:12.640Z","repository":{"id":36955111,"uuid":"457703549","full_name":"oasisprotocol/docs","owner":"oasisprotocol","description":"Official documentation for the Oasis Network.","archived":false,"fork":false,"pushed_at":"2025-04-28T08:55:20.000Z","size":136660,"stargazers_count":14,"open_issues_count":46,"forks_count":35,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-04-28T10:04:42.168Z","etag":null,"topics":["blockchain","crypto","docs","documentation","docusaurus","markdown","network","oasis"],"latest_commit_sha":null,"homepage":"https://docs.oasis.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oasisprotocol.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,"zenodo":null}},"created_at":"2022-02-10T09:01:28.000Z","updated_at":"2025-04-28T08:52:28.000Z","dependencies_parsed_at":"2024-01-08T15:08:35.238Z","dependency_job_id":"ce0fdd34-7264-4970-bf0f-5545f5d07472","html_url":"https://github.com/oasisprotocol/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/oasisprotocol%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oasisprotocol%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oasisprotocol%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oasisprotocol%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oasisprotocol","download_url":"https://codeload.github.com/oasisprotocol/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252524283,"owners_count":21762066,"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":["blockchain","crypto","docs","documentation","docusaurus","markdown","network","oasis"],"created_at":"2024-11-13T13:15:57.578Z","updated_at":"2025-05-05T15:33:12.633Z","avatar_url":"https://github.com/oasisprotocol.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oasis Docs\n\n![CI tests status](https://github.com/oasisprotocol/docs/actions/workflows/ci-test.yml/badge.svg)\n![CI links status](https://github.com/oasisprotocol/docs/actions/workflows/ci-links.yml/badge.svg)\n![Deployment status](https://github.com/oasisprotocol/docs/actions/workflows/deploy-main.yml/badge.svg)\n\nThis repository contains Oasis Docs deployed at \u003chttps://docs.oasis.io/\u003e.\n\nThey are built using [Docusaurus 2](https://docusaurus.io/), a modern static\nwebsite generator.\n\n## Installation\n\nInstall Node packages with:\n\n```\nyarn\n```\n\nCheckout all Git submodules with:\n\n```\ngit submodule update --init\n```\n\n## Local Development\n\nTo start the local development server, use:\n\n```\nyarn start\n```\n\nThis command will start a local development server. Open your browser at\n\u003chttp://localhost:3000/\u003e to load the site.\n\nMost changes will be reflected live without having to restart the server.\n\n## Build\n\nTo generate the static site, use:\n\n```\nyarn build\n```\n\nThis will generate the static content in the `build` directory. Its contents\ncan be served using any static content hosting service.\n\n## Deployment\n\nDocs will be automatically re-generated and re-deployed once a pull request is\nmerged into the `main` branch.\n\n## Broken Link Checker\n\nDocusaurus already checks all internal links when running `yarn build`.\n\nTo also check all external links using a local Oasis Docs instance, do the\nfollowing:\n\n1. Specify URL env variable and generate the static site:\n\n   ```\n   URL=http://localhost:3000/ yarn build\n   ```\n\n2. Serve the static site locally:\n\n   ```\n   yarn serve --no-open\n   ```\n\n3. Run broken link checker in a new terminal with:\n\n   ```\n   yarn blc\n   ```\n\n_NOTE: Some external URLs appear to be receiving wrong 200-ish HTTP code despite\nopening correctly in the browser. Exclude those links manually from the broken\nlink checker in `package.json`._\n\n## Guidelines for writing Oasis docs\n\n### Documentation structure\n\n`docs` folder contains markdown files of the documentation. Each subfolder\nrepresents a documentation **part** (general, node, build, paratime, core etc.).\nEach markdown file inside a part corresponds to a **chapter** (subchapter for a\nmarkdown file inside a subfolder) and each subtitle of a chapter is called a\n**section** (subsection etc.).\n\nSome parts may contain markdown files or folders hosted and maintained in other\nOasis repositories (e.g. oasis-sdk, oasis-core). In this case, a complete git\nsubmodule for the repository is cloned inside `external` folder. Then, symbolic\nlinks to specific markdown files or folders are added inside `docs`\naccordingly.\n\nWhile all markdown files inside `docs` are compiled, not all files may be\nreachable via sidebars directly. Each top-level chapter defines own\nsidebar structure inside their `sidebarChapterName.ts` file.\n\nNouns, adjectives and verbs in the titles should be capitalized.\n\n### index.md, README.md, overview.md\n\nPlease use `README.md` as the filename for introductory chapters.\n\nIntroductory chapters should not have a separate entry in the sidebar, but\nshould be accessible by clicking on the category link directly.\n\n### Referencing documents between the top-level chapters\n\nMarkdown files hosted by this repository should:\n\n- reference markdown files in the same or any other chapter by a relative\n  path e.g.\n  `../howto-use-wallet.md`.\n  `../../../operators/set-up-your-node.md`\n\nSymlinked Markdown files hosted by other Oasis repositories should:\n\n- reference markdown files in the same repository by a relative path e.g.\n  `../howto-write-contract.md`.\n- reference markdown files in other repositories by using github.com URL e.g.\n  `https://github.com/oasisprotocol/docs/blob/main/docs/general/mainnet/damask-upgrade.md`\n\nThis way, the documentation of each external repository is self-contained and no\nbroken links should exist. When the submodules are wrapped inside the Oasis\ndocs and compiled, the github.com URLs will be rewritten into the corresponding\ndocumentation links by the markdown preprocessor (remark plugin).\n\n### DocCards\n\nDocCards are attractive elements commonly used in the introductory\nchapters and *See also* or *Read more* sections. Apart from the built-in\ndocusaurus `\u003cDocCardList /\u003e` helper which prints all items in the category, you\ncan also list specific items by calling our `findSidebarItem()` helper passing\nthe href of the target page.\n\n`DocCardList` will show two DocCards per row while the `DocCard` component\nwill span horizontally over the whole site resembling page links in gitbook.\n\nPlease fill the `description:` frontmanner for chapters which are referenced in\nthe DocCards.\n\n### Code snippets from files\n\nYou can make code blocks show a code stored in external files, by using the\n`code` literal as the first word inside the image alt field. For example:\n\n```markdown\n![code](../../examples/somefile.go)\n```\n\n`code-block-snippets` remark plugin will replace the image syntax above with\nthe code block syntax and import the referenced file.\n\nAdditionally, you can specify the language, code title and lines of code or the\nregion name:\n\n```markdown\n![code go](../../examples/somefile.go \"Some external file\")\n![code go](../../examples/somefile.go#L14 \"Line 14 in the file\")\n![code go](../../examples/somefile.go#L14-L16 \"Lines 14-16 in the file\")\n![code go](../../examples/somefile.go#some-region \"Some external file region\")\n```\n\nTo define the region in the referenced file put `#region some-region-name` and\n`#endregion some-region-name` as a comment line.\n\nHighlighting specific lines also work by passing the list of lines and/or line\nranges as a third parameter:\n\n```markdown\n![code go {5-8,13,21}](../../examples/somefile.go)\n```\n\n### Backward compatibility\n\nWhen you move, rename or delete previously published content, make sure that\n**any previously valid URL will always point to the new valid location**. Set\nup redirects in `redirects.ts` accordingly and leave the pull request\nnumber in the comment which added this redirection for future reference, if\nmajor rewrite is to happen and the developers would need more context around\nthe redirection.\n\n### Images\n\nThere are three kinds of image assets used in the docs.\n\n1. Screenshots, photos, non-technical figures go into `images/` folder\n   on the part-level (i.e. `docs/build/images`). External repositories may use\n   own images in their respective folder.\n2. [Mermaid](https://mermaid-js.github.io) diagrams (preferred tool for\n   sequence diagrams, flowcharts and other technical material) live in\n   `diagrams/` folder of the respective part or the external repository. Diagram\n   sources reside in the .mmd files. To generate .svg which can be used in the\n   markdown run `yarn diagrams`. Both .svg and .mmd files should be stored in\n   git. CI will check that they are always in sync.\n3. Other diagrams which cannot be designed with Mermaid are drawn in\n   [diagrams.net](https://diagrams.net) and then stored locally inside\n   `images/` folder along other images. When exporting the diagram, don't\n   forget to tick the \"Include a copy of my diagram\" checkbox so that the\n   diagram source will be stored along in the .svg file and you will\n   be able to edit it in the future.\n\n#### Dark Mode\n\nWe aim to support dark mode when introducing new assets. We prefer to include\nassets with dark mode friendly CSS using `@media (prefers-color-scheme: dark)`\nwhen possible. We generate Mermaid diagrams with dark mode CSS injected, and\nexport [diagrams.net](https://diagrams.net) diagrams with a transparent\nbackground and \"Automatic\" appearance.\n\n## Vocabulary\n\nThe following is a consistent case-sensitive collection of Oasis-related terms,\nand their usage including the articles:\n\n- Bech32\n- c10l\n  Check out the c10l-hello-world folder for the confidential version of the\n  original example.\n- c13y\n  EVM with added c13y.\n- CBOR\n- Cipher\n- consensus layer\n  The consensus layer makes sure that the ParaTimes tick.\n- Ed25519\n  The consensus layer only supports the Ed25519 signature scheme.\n- Emerald\n- dApp\n  Sapphire supports writing dApps. DApp is a modern distributed application.\n- key manager\n- key manager node\n- Mainnet\n  This feature is also enabled on Mainnet.\n- Testnet\n  This only runs on Testnet.\n- Oasis CLI\n  You can use the Oasis CLI to set up your wallet.\n- Oasis Core\n- Oasis Network\n  The Oasis Network is a proof-of-stake network.\n- OPL\n  Oasis Privacy Layer supports privacy of dApps on all EVM chains.\n- ParaTime\n  Each ParaTime stores its own state separate from the consensus state.\n- ParaTime layer\n  The ParaTime layer supports up to a thousand runtimes running in parallel.\n- ROSE\n  Please send 10.00000000 ROSE to the address above.\n- ROSE Wallet\n  Since this is not supported by MetaMask, please use the ROSE Wallet instead.\n- runtime\n- Sapphire\n- secp256k1\n  The Koblitz curve secp256k1 parameters are deterministic.\n- Sr25519\n- TEST\n  Please send 10.00000000 TEST to the address above.\n- trusted execution environment\n- validator\n- validator node\n- Wasm\n- Web3 gateway\n  We strongly suggest that you set up your own Web3 gateway for your Sapphire\n  endpoint.\n\n## License\n\nThe Oasis documentation software and code snippets inside the documentation are\nlicensed under [Apache 2.0](./LICENSE).\n\nThe content of the documentation (the `/docs` folder) including the media (e.g.\nimages and diagrams) is licensed under [Creative Commons Attribution 4.0\nInternational](./LICENSE-docs).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foasisprotocol%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foasisprotocol%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foasisprotocol%2Fdocs/lists"}