https://github.com/manifoldfinance/kb

knowledge base and documentation resource portal for CommodityStream/Manifold Finance
https://github.com/manifoldfinance/kb

defi docs documentation ethereum governance how-to knowledge-base solidity specification tutorials

Last synced: 4 months ago
JSON representation

knowledge base and documentation resource portal for CommodityStream/Manifold Finance

• Host: GitHub
• URL: https://github.com/manifoldfinance/kb
• Owner: manifoldfinance
• License: other
• Created: 2022-07-01T03:14:40.000Z (over 3 years ago)
• Default Branch: trunk
• Last Pushed: 2023-01-04T12:31:57.000Z (almost 3 years ago)
• Last Synced: 2024-05-19T00:36:40.643Z (over 1 year ago)
• Topics: defi, docs, documentation, ethereum, governance, how-to, knowledge-base, solidity, specification, tutorials
• Language: TypeScript
• Homepage: https://kb.manifoldfinance.com
• Size: 9.35 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-UPL.txt
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
# [`kb.manifoldfinance.com`](https://kb.manifoldfinance.com)

[![nodejs](https://github.com/manifoldfinance/kb/actions/workflows/nodejs.yml/badge.svg)](https://github.com/manifoldfinance/kb/actions/workflows/nodejs.yml)

> [https://kb-manifold.vercel.app/](https://kb-manifold.vercel.app/)

> **Warning** 
 This resource is in active development, content may be inaccurate or out of date!

This is the home of the `kb.docs` resource. V2 Documentation is maintained here. This resource follows the `Diátaxis` guidelines, which you can read more about below.

If you have a question you can always post it on our discourse forums → [forums.manifoldfinance.com](https://forums.manifoldfinnce.com)

## [Diátaxis](https://diataxis.fr/)

> A systematic framework for technical documentation authoring. 
 The Grand Unified Theory of Documentation 
 —David Laing

The Diátaxis framework aims to solve the problem of structure in technical documentation. It adopts a systematic approach to understanding the needs of documentation users in their cycle of interaction with a product.

> **Note** 
 The name Diátaxis comes from the Ancient Greek δῐᾰ́τᾰξῐς: dia (“across”) and taxis (“arrangement”).

Diátaxis identifies four modes of documentation - tutorials, how-to guides, technical reference and explanations. It derives its structure from the relationship between them.

In Diátaxis, each of these modes (or types) answers to a different user need, fulfills a different purpose and requires a different approach to its creation.

## Resources

This is a Docusarus Site templated with the Diataxis layout of creating and viewing documentation.

## License

Copyright 2022 (C) - CommodityStream Inc, & Manifold Finance, Inc. All Rights Reserved

### Code Examples License

Example code provided is licensed under either of

-   Universal Permissive License 1.0 ([LICENSE-UPL](LICENSE-UPL) or https://opensource.org/licenses/UPL)

-   Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

at your option.

### Code Examples Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Universal Permissive License v 1.0 license, shall be dual licensed as above, without any additional terms or conditions.