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

Conversation

Savio-Sou
Copy link
Collaborator

@Savio-Sou Savio-Sou commented Nov 23, 2023

Description

Summary*

This PR adds a new "Specs" doc instance in the top navigation bar of the Noir Docs that carries the to-be-drafted Noir 1.0 specifications.

This gives us the foundation to start iteratively drafting the 1.0 specs in public.

Additional Context

Existing spec pages in this PR are merely placeholder copies from v0.19.2 docs.

We can add / delete / modify both sections and pages as we go.

PR Checklist*

  • I have tested the changes locally.
    • With the new doc-gen that added the need to build the Noir's JS packages when building docs locally, I have yet to resolve the dependency issues with e.g. libiconv, CoreFoundation, etc. for building them on my machine.
    • Relying on the GitHub Action Netlify preview for now.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 23, 2023
@Savio-Sou Savio-Sou changed the title docs: Add a new "Specs" instance feat(docs): Add a new "Specs" instance Nov 23, 2023
Copy link
Contributor

github-actions bot commented Nov 24, 2023

@Savio-Sou Savio-Sou marked this pull request as ready for review November 24, 2023 17:07
@TomAFrench TomAFrench changed the title feat(docs): Add a new "Specs" instance chore(docs): Add a new "Specs" instance Dec 14, 2023
@TomAFrench
Copy link
Member

Is this PR still active or shall we close it?

@kevaundray
Copy link
Contributor

We can close since we have a Noir 1.0 document that we use

@kevaundray kevaundray closed this Dec 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants