GithubHelp home page GithubHelp logo

Comments (5)

 avatar commented on June 11, 2024

Happy to look at this one if you like

from pnp-js-core.

patrick-rodgers avatar patrick-rodgers commented on June 11, 2024

Great, it's all yours!

from pnp-js-core.

sympmarc avatar sympmarc commented on June 11, 2024

If it's at all useful from a comparison perspective, this is what I did for the SOAP Services in SPServices: https://spservices.codeplex.com/documentation

IMO, it's important that the examples actually DO something - and not something that no human would ever want to do.

There has to be a good index that gets people to the right place in a couple of clicks, and not only by using Google.

And any place where there's an assumption of prior knowledge should link back to that atomic building step.

Also, @patrick-rodgers - are you thinking this goes through the doc team, or does it just live in the GitHub project?

There, my $.03.

from pnp-js-core.

 avatar commented on June 11, 2024

Thanks a lot @sympmarc.

There's a great discussion in #6 about automatic document generation using JSDOC and i assume we're using jsdoc comment notation @patrick-rodgers?

from pnp-js-core.

patrick-rodgers avatar patrick-rodgers commented on June 11, 2024

Closing due to work in #70.

from pnp-js-core.

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.