Skip to content
This repository has been archived by the owner on Oct 17, 2023. It is now read-only.

Document #1114 #104

Closed
phated opened this issue Apr 21, 2023 · 8 comments · Fixed by #149
Closed

Document #1114 #104

phated opened this issue Apr 21, 2023 · 8 comments · Fixed by #149
Milestone

Comments

@phated
Copy link
Contributor

phated commented Apr 21, 2023

This didn't trigger the workflow (maybe because it was an older PR?) so I'm manually opening.

The UP + new source build workflow stuff in noir-lang/noir#1114 needs to be documented

@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Apr 21, 2023
@signorecello
Copy link
Collaborator

This is for v0.5.0 @critesjosh, I'll prioritize the ones for v0.4.1

@signorecello signorecello added this to the v0.5.0 milestone Apr 25, 2023
@critesjosh
Copy link
Collaborator

critesjosh commented May 4, 2023

@phated is this still relevant now that we can install 0.5.0 with noirup?

Edit: I see that noirup does not address building from source. Would it be sufficient to link to this section of the noir README as the source of truth so we dont need to maintain it in two places?

@Savio-Sou
Copy link
Contributor

Would it be sufficient to link to this section of the noir README as the source of truth so we dont need to maintain it in two places?

Sounds good to me (would be great to get your confirmation too @phated on e.g. if the instructions are planned to stay there).

@Savio-Sou Savio-Sou pinned this issue May 8, 2023
@Savio-Sou Savio-Sou unpinned this issue May 8, 2023
@phated
Copy link
Contributor Author

phated commented May 9, 2023

I don't believe it will be sufficient to link to the readme because @kevaundray wanted that to move to somewhere shared (possibly the website?). See noir-lang/noir#1199

@Savio-Sou
Copy link
Contributor

So the other way round with the docs as the source of truth then?

@phated
Copy link
Contributor Author

phated commented May 10, 2023

So the other way round with the docs as the source of truth then?

Possibly, but they need to be written in a way that is generic enough for all noir-lang projects to link to. I can take a stab when I have some free time.

@Savio-Sou
Copy link
Contributor

We probably don't need the generic version of nix instructions in the docs, as most readers will be reading it just for compiling Nargo (instead of also other repos).

To unblock us from releasing v0.5.1, let's:

  1. Copy-paste the current instructions in noir-lang/noir’s README into docs
  2. Release v0.5.1
  3. Write up a generic version of instructions at some common place later

(Copy-pasting instead of linking for (1) to avoid broken links if we have to move things around during (3).)

@signorecello / @critesjosh grateful if one of you could take (1) on 🙌

@critesjosh
Copy link
Collaborator

critesjosh commented May 12, 2023

yes will do. just to be clear, this will replace the "Compile from source" section of the docs for versions >=0.5.1, correct?

@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir May 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants