{"id":19927653,"url":"https://github.com/mgielda/riscv-doc","last_synced_at":"2026-03-05T15:33:23.452Z","repository":{"id":72081353,"uuid":"63503233","full_name":"mgielda/riscv-doc","owner":"mgielda","description":"Documentation for RISC-V","archived":false,"fork":false,"pushed_at":"2016-07-17T12:54:55.000Z","size":3,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-27T06:21:26.772Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"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/mgielda.png","metadata":{"files":{"readme":"README.rst","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-16T21:37:29.000Z","updated_at":"2016-07-16T22:20:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"cb5e6db4-c73c-4442-a9d5-ecf6f1ce993a","html_url":"https://github.com/mgielda/riscv-doc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mgielda/riscv-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgielda%2Friscv-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgielda%2Friscv-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgielda%2Friscv-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgielda%2Friscv-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mgielda","download_url":"https://codeload.github.com/mgielda/riscv-doc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgielda%2Friscv-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30133286,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T14:41:47.141Z","status":"ssl_error","status_checked_at":"2026-03-05T14:41:21.567Z","response_time":93,"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":[],"created_at":"2024-11-12T22:34:20.580Z","updated_at":"2026-03-05T15:33:23.435Z","avatar_url":"https://github.com/mgielda.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"RISC-V documentation\n====================\n\nA very important aspect of the RISC-V effort will be good documentation of all aspects of the ISA as well surrounding\ntechnologies, topics and ideas.\n\nTutorials, introductory material and 'user documentation' will also matter, especially as we strive towards more adoption.\n\nPicking the right technology for this end is necessary. The documentation framework has to enable both creating PDF documentation \n(crucial for any technical/datasheet style documentation) as well as HTML - which is necessary for any modern project. Another\nimportant consideration should be the ease of creating the documentation, as we need people to be able to easily describe their\nwork and collaborate.\n\nLaTeX\n-----\n\nLaTeX, while a venerable and traditional standard for all sorts of (especially more 'technically-oriented') documents,\nseems ill-suited for adopting as a documentation standard for a new project, as it is quite complex and does not output HTML.\n\nMarkdown\n--------\n\nMarkdown is excellent in terms of adoption and HTML output, but it does not offer proper tooling for LaTeX output.\nThere is a Markdown-based documentation tool called `MkDocs \u003chttp://www.mkdocs.org/\u003e`_, but it only outputs HTML.\nAlso, many people have complained about Markdown's inherent inability to represent more complicated document structures due\nto the very simplicity that makes it popular.\n\nRST\n---\n\nAnother option is `ReStructuredText (RST) \u003chttps://en.wikipedia.org/wiki/ReStructuredText\u003e`_, a format used extensively in\ndocumetning the Python programming language and its libraries. RST source can be used to generate both HTML and LaTeX/PDF, and in\nfact it is designed for technical documentation. The most widely used RST tool is `Sphinx \u003chttp://sphinx.pocoo.org/\u003e`_, the\nde-facto standard for working with RST documentation, providing convenient extensions, structure, customization options etc.\nSphinx itself is also written in Python, easily extendible and actively developed.\n\nCons:\n\n- no JavaScript RST parsers for on-the-fly rendering in the browser [#]_\n\n.. [#] I would actually propose that we write one, if we're serious about it\n\nFor more info, see `the reST playground \u003creStructuredText.rst\u003e`_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgielda%2Friscv-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmgielda%2Friscv-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgielda%2Friscv-doc/lists"}