Giter Club home page Giter Club logo

Comments (8)

yograterol avatar yograterol commented on May 17, 2024

Will be great if the contributor doc accompanies it.

from vyper.

fubuloubu avatar fubuloubu commented on May 17, 2024

Well, I didn't even know that was a thing until 30 seconds ago... lol.

from vyper.

fubuloubu avatar fubuloubu commented on May 17, 2024

Further thoughts: Does the grammer, types/feature explanations, and example need to be on the readme? I feel like it's cluttering up that main page and should be moved to the docs (how is that coming by the way? I have no idea what the web address is for the docs).

Also, the example is inconsistent with the one in the examples/ folder (extra assert statement on the README example)

from vyper.

DavidKnott avatar DavidKnott commented on May 17, 2024

I agree 100%, moving info from the readme to the docs has been on my to do list for a while.

from vyper.

fubuloubu avatar fubuloubu commented on May 17, 2024

If you let me know where the documentation is going I can do that for you. I don't understand where that whole skeleton thing is supposed to get generated to work on it though (e.g. web address), and I've been too lazy to figure it out lol.

from vyper.

DavidKnott avatar DavidKnott commented on May 17, 2024

That'd be great, here's a link to the Viper docs (currently the build is failing and I haven't to look into it yet). make docs is working though so if you want, you can start moving stuff from the readme into the rst files. I've been using the solidity docs as a reference.

from vyper.

fubuloubu avatar fubuloubu commented on May 17, 2024

Oh, okay I gotcha now. I'll check it out tomorrow and submit a PR (or multiple) when I get a chance. It's been driving me a little crazy how scattered everything is when I look for it.

Should we close this issue for now? #333 is merged and closed.

from vyper.

DavidKnott avatar DavidKnott commented on May 17, 2024

That'd be great, I'll close this issue and merge in #333 to keep things clean.

from vyper.

Related Issues (20)

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.