Coder Social home page Coder Social logo

Add documentation in en_US about correios HOT 3 OPEN

olist avatar olist commented on June 3, 2024
Add documentation in en_US

from correios.

Comments (3)

robertoduessmann avatar robertoduessmann commented on June 3, 2024

I'd like to help with this. Do you have any idea or doc to be based?
Because I was confused when I access documentation folder...

from correios.

osantana avatar osantana commented on June 3, 2024

Create a "docs" folder with sphinx-build and create documentation for:

  • Basic tutorial with some client APIs basic usage (eg. SIGEP, SRO, etc)
  • Basic tutorial for Posting List / ShippingLabel PDF generation
  • Reference of main models APIs

from correios.

robertoduessmann avatar robertoduessmann commented on June 3, 2024

Very nice, now I understood @osantana . I opened the pull request #101 with a skeleton suggestion to organize the docs.

Do you can take a look and comment what you think? I created some md files to simplify the access to docs.

from correios.

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.