Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Add a new "Specs" instance #3554

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,22 @@ const config = {
href: '/',
},
items: [
{
href: 'https://github.com/noir-lang/noir/tree/master/docs',
label: 'GitHub',
position: 'right',
},
{
type: 'docsVersionDropdown',
position: 'left',
dropdownActiveClassDisabled: true,
},
{
type: 'doc',
docId: 'index',
label: 'Specs',
docsPluginId: 'specs',
},
{
href: 'https://github.com/noir-lang/noir/tree/master/docs',
label: 'GitHub',
position: 'right',
},
],
},
metadata: [
Expand Down Expand Up @@ -147,6 +153,15 @@ const config = {
},
},
plugins: [
[
'@docusaurus/plugin-content-docs',
{
id: 'specs',
path: 'specs',
routeBasePath: 'specs',
sidebarPath: './sidebarsSpecs.js',
},
],
[
'docusaurus-plugin-typedoc',
{
Expand Down
103 changes: 103 additions & 0 deletions docs/sidebarsSpecs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation

The sidebars can be generated from the filesystem, or explicitly defined here.

Create as many sidebars as you want.
*/

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
sidebar: [
{
type: 'doc',
id: 'index',
label: 'Specs',
},
{
type: 'category',
label: 'Language',
items: [
{
type: 'category',
label: 'Data Types',
link: {
type: 'doc',
id: 'language/data_types',
},
items: [
{
type: 'autogenerated',
dirName: 'language/data_types',
},
],
},
'language/functions',
'language/control_flow',
'language/ops',
'language/assert',
'language/unconstrained',
'language/generics',
'language/mutability',
'language/lambdas',
'language/comments',
'language/distinct',
'language/shadowing',
],
},
{
type: 'category',
label: 'Noir Standard Library',
items: [
{
type: 'category',
label: 'Cryptographic Primitives',
link: {
type: 'doc',
id: 'standard_library/cryptographic_primitives',
},
items: [
{
type: 'autogenerated',
dirName: 'standard_library/cryptographic_primitives',
},
],
},
'standard_library/recursion',
'standard_library/logging',
'standard_library/merkle_trees',
'standard_library/zeroed',
'standard_library/black_box_fns',
'standard_library/options',
],
},
{
type: 'category',
label: 'Compiler',
items: [{ type: 'autogenerated', dirName: 'compiler' }],
},
{
type: 'category',
label: 'ACVM',
items: [{ type: 'autogenerated', dirName: 'acvm' }],
},
{
type: 'category',
label: 'Tooling',
items: [
{
type: 'category',
label: 'Nargo',
items: [{ type: 'autogenerated', dirName: 'tooling/nargo' }],
},
],
},
],
};

module.exports = sidebars;
5 changes: 5 additions & 0 deletions docs/specs/acvm/01_todo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Todo
description: Todo
keywords: [Todo]
---
5 changes: 5 additions & 0 deletions docs/specs/compiler/01_todo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Todo
description: Todo
keywords: [Todo]
---
20 changes: 20 additions & 0 deletions docs/specs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Noir 1.0 Specifications
description: Specifications of the 1.0 version of Noir the Zero Knowledge Language.
keywords: [Noir, Zero Knowledge, Domain Specific Language, Rust]
slug: /
---

:::warning

This is a work in progress.

:::

Welcome to the specifications of Noir version 1.0.

Noir is a Domain Specific Language for SNARK proving systems. It has been designed to use any ACIR compatible proving system.

Its design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.

Select the pages you would like to read from the sidebar on the left.
Loading
Loading