Giter Club home page Giter Club logo

Comments (3)

jacogr avatar jacogr commented on July 22, 2024 1

Luke, sorry, only noticed this question now - I would like to keep things consistent. So what we do on the api repo, that is what we should do here.

from common.

ltfschoen avatar ltfschoen commented on July 22, 2024

@jacogr What's your preference for generating API docs, which of the following would you prefer?

  1. using typedoc to build docs from ESDoc comments (i.e. PR #135 that has been merged) OR
  2. creating nested markdown files (see https://github.com/polkadot-js/common/tree/master/packages/util-keyring/docs) OR
  3. adding docs to a Readme file similar to @palanisn's approach navp4l/api@42ca54d in addressing w3f/General-Grants-Program#34 OR
  4. possibly a better way?

from common.

polkadot-js-bot avatar polkadot-js-bot commented on July 22, 2024

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue if you think you have a related problem or query.

from common.

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.