Docs
Official documentation for the Oasis Network.
Overview
The Oasis Docs repository provides a comprehensive guide for utilizing Oasis technologies, hosted at https://docs.oasis.io/. Built with Docusaurus 2, a contemporary static website generator, this platform offers a seamless and efficient experience for both developers and users seeking to access or contribute to the documentation. With simple installation and deployment procedures, it streamlines the development process, making it accessible for individuals and teams alike.
This repository not only focuses on delivering high-quality documentation but also integrates tools to ensure the accuracy and integrity of linked content. Whether you're a newbie venturing into Oasis or a seasoned developer, the structure of the documentation is designed to facilitate easy navigation and comprehension of complex topics.
Features
-
Modern Static Site Generation: Built with Docusaurus 2, this setup ensures a fast and responsive user experience, optimizing page load times and interactivity.
-
Live Local Development: Easily start a local development server to preview your changes in real time, enhancing your productivity during updates and revisions.
-
Automated Deployment: Documentation updates are automatically re-generated and deployed upon merging pull requests, streamlining the process of keeping content fresh and accurate.
-
Link Validation: Includes a built-in broken link checker to maintain the integrity of internal links and easily identify issues with external links, essential for a smooth user experience.
-
Structured Documentation: Well-organized markdown files categorized into folders make it easy to find specific topics and follow the documentation's flow.
-
Comprehensive Guidelines: Detailed instructions on how to properly reference files and structure documentation ensure consistency and clarity throughout the repository.
-
Git Submodules Integration: Supports the inclusion of markdown files hosted in other repositories, enabling a collaborative approach to documentation across multiple Oasis projects.
Overall, the Oasis Docs repository stands out as a valuable resource for developers looking to deepen their understanding of Oasis technology while contributing effectively to the project.
- Docusaurus
Docusaurus is an open-source static site generator designed for creating documentation websites. Developed by Facebook, it simplifies the process of building, deploying, and maintaining documentation with its React-based framework and pre-configured setup for documentation projects.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.