Coder Social home page Coder Social logo

documentation anywhere?? about contractor HOT 7 CLOSED

elementary avatar elementary commented on June 3, 2024 2
documentation anywhere??

from contractor.

Comments (7)

curioussavage avatar curioussavage commented on June 3, 2024

sorry - I found the docs here https://valadoc.org/granite/Granite.Services.ContractorProxy

A link to that from the entry in the interface guidelines and in the readme of this repo would be awesome.

from contractor.

curioussavage avatar curioussavage commented on June 3, 2024

On second look it seems that link is to a wrapper for the service.

from contractor.

danirabbit avatar danirabbit commented on June 3, 2024

Closing since OP submitted a PR to fix this issue

from contractor.

matzipan avatar matzipan commented on June 3, 2024

The PR was closed as invalid since he commented that the link is not correct

from contractor.

peteruithoven avatar peteruithoven commented on June 3, 2024

That valadoc shouldn't really count as proper documentation I think?
It for example doesn't mention:

  • the folder to put the files in,
  • the syntax of the files,
  • The Exec arguments like %f, %U
  • How to debug (maybe get terminal output of execution?)

The following stack exchange answers might contain a start:

from contractor.

jeremypw avatar jeremypw commented on June 3, 2024

I am going to close this for now as at least some documentation and examples are provided in the README.md file now. There is no clear end point for this issue. Any suggestions for particular further documentation can be raised as separate issues

from contractor.

peteruithoven avatar peteruithoven commented on June 3, 2024

Another issue on documenting contract files in the developer documentation: https://github.com/elementary/website/issues/936

from contractor.

Related Issues (18)

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.