diff --git a/docusaurus-site/docs/intro.md b/docusaurus-site/docs/intro.md deleted file mode 100644 index 8417aebee8c72f088bcfb14568f56a7fa6ec5f42..0000000000000000000000000000000000000000 --- a/docusaurus-site/docs/intro.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Tutorial Intro - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**: - -```shell -npm init docusaurus@latest my-website classic -``` - -## Start your site - -Run the development server: - -```shell -cd my-website - -npx docusaurus start -``` - -Your site starts at `http://localhost:3000`. - -Open `docs/intro.md` and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docusaurus-site/docs/overview.md b/docusaurus-site/docs/overview.md new file mode 100644 index 0000000000000000000000000000000000000000..8a6cb7640a674e15d7afb3befba04595599bde8b --- /dev/null +++ b/docusaurus-site/docs/overview.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# Overview + +The Client API (xxDK) is the client-side software for communicating with the cMix network, a privacy protecting layer within the larger xx network. cMix builds on current data protection mechanisms by extending security beyond just content to include metadata — the what, when, where, and how of user activity. + +The xxDK helps developers provide unparalleled privacy for their users by implementing xx network messaging features such as end-to-end encryption and metadata protection. It comes with an API library and related command line facilities that enable developers build full-featured xx clients for all platforms. Additionally, the base messaging protocols can be extended. + +Some use cases for integrating the API into your applications include (but are not limited to) building: + +- Banking applications +- Voting applications, such as [Votexx](https://votexx.org/) +- Secure messaging apps for private communications + +<aside> +💡 If you'd like to learn more about the cMix protocol and what it offers, a good place to start is [the cMix whitepaper](https://xx.network/xxcMixwhitepaper.pdf). + +</aside> + +It's easy to get started with the xxDK. Explore these links below to find what you need. + +### Getting Started + +The Getting Started guide is the place to begin if you're looking to get up-and-running quickly. + +### The API Reference + +The API Reference provides extensive detail on the different types and functions exposed by the Client API. + +### Technical Glossary + +Use the technical glossary to find meanings to unfamiliar terms and concepts specific to the cMix system. + +### FAQs + +Refer to the FAQ for answers to some of our users' most common questions.