Add repo link to mdbook #93
Conversation
docs/src/introduction.md
Outdated
| The code for AirScript can be found [here](https://github.com/0xPolygonMiden/air-script/). | ||
|
|
There was a problem hiding this comment.
It might be good to put the link right at the top so it's easiest to find. Maybe we could either edit the first sentence to include a link or add the sentence right after it?
Polygon Miden's AirScript is designed to make it simple to describe AIR constraints and generate efficient and accurate code in the required target language.
OR
Polygon Miden's AirScript is designed to make it simple to describe AIR constraints and generate efficient and accurate code in the required target language. The code for AirScript can be found here.
There was a problem hiding this comment.
I went with the second option because it might be easy to overlook the link in the first.
There was a problem hiding this comment.
Another, potentially complementary, option is to go with the corresponding feature in mdbook. In book.toml:
[output.html]
git-repository-url = "https://github.com/0xPolygonMiden/air-script/"There was a problem hiding this comment.
@jan-ferdinand Thanks. This looks great.
|
I think it's good as you've done it for now without contributing info in the docs, but I don't feel strongly. |
tohrnii
force-pushed
the
docs
branch
2 times, most recently
from
1c0b649 to
7287eff
Compare
|
I realized that the README changes should probably be made to main so I've removed it from this PR and will open another one that merges to main. |
tohrnii
changed the title
Question: Should the contributing guidelines be added to mdbook as well if the docs could be a possible entry point for people or maybe just added to the mdbook and removed from repo readme?