Git Product home page Git Product logo

acvm-docs's People

Contributors

critesjosh avatar ludamad avatar vezenovm avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

acvm-docs's Issues

Add documentation around why we need brillig

Problem

We should explain why we have it/use cases for it.

Proposed solution

See: noir-lang/acvm#191

Alternatives considered

No response

Additional context

No response

Submission Checklist

  • Once I hit submit, I will assign this issue to the Project Board with the appropriate tags.

Brillig: Enhance documentation around Stop, Return, and Foreign Call

Problem

  1. Discuss more the nuances of compiling opcodes like when to use Stop, Return and Foreign Call
  2. Discuss in more detail in the example how the foreign call would be handled with the syscall analogy

Happy Case

This explains to a generally technical programmer how to write a compiler that uses these, and how to think of their execution model

Alternatives Considered

Don't document this, they use the code. This is always the fallback plan, but we don't want the code to be the spec.

Additional Context

No response

Would you like to submit a PR for this Issue?

Yes

Support Needs

No response

Add documentation around what opcodes brillig supports

Problem

We need documentation around what opcodes Brillig will support for advanced developers who want to inspect the Brillig opcode or for those who want to create a frontend which compiles to it.

Proposed solution

See: noir-lang/acvm#227

Alternatives considered

No response

Additional context

No response

Submission Checklist

  • Once I hit submit, I will assign this issue to the Project Board with the appropriate tags.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.