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

Fix reference doc gen for CompiledCircuit, ProofData and compile_program in versioned docs #5018

Open
Savio-Sou opened this issue May 10, 2024 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented May 10, 2024

Aim

Read about the types themselves and members contained within in the Noir Docs.

Expected Behavior

These reference descriptions should have been generated and published in the docs, like ProofData in v0.25.0.

Bug

Seemingly since somewhere between v0.25.0 to v0.27.0, the doc gen started resulting in "Renames and re-exports..." rather than information of the types for:

This might be specific to versioned docs, as dev version of docs seem unaffected.

To Reproduce

Visit https://noir-lang.org/docs/v0.27.0/reference/NoirJS/backend_barretenberg/#references as an example.

Project Impact

Nice-to-have

Impact Context

No response

Workaround

Yes

Workaround Description

  • Read dev version of docs
  • Read code directly

Would you like to submit a PR for this Issue?

None

Support Needs

No response

@Savio-Sou Savio-Sou added bug Something isn't working documentation Improvements or additions to documentation labels May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants