Code Monkey home page Code Monkey logo

Comments (4)

dbu avatar dbu commented on August 20, 2024

what exactly do you mean? avoid the duplication?

from documentation.

sagikazarmark avatar sagikazarmark commented on August 20, 2024

Yeah. Both documents the same thing: how to use them in reusable packages and applications. They should probably be merged or grouped somehow I think.

from documentation.

dbu avatar dbu commented on August 20, 2024

agreed. duplication in documentation is just as bad as code duplication: confusing for the reader, and bound to go out of sync. my initial idea with the dedicated "virtual package" page was to make that something maintainers of libraries using httplug could link to for their users. but in the usage section, i felt we should explain how things work. i see two options:

a) eliminate the dedicated page. con: makes the information harder to link, and it might need to be a bit short when explaining in the context of installing httplug implementations.
b) only mention "virtual package" and link to the decicated page without further background information in the usage instructions. con: less linear to read through.

i tend towards option b, wdyt?

from documentation.

sagikazarmark avatar sagikazarmark commented on August 20, 2024

Fine with that. The tutorial should be clean enough to understand how to use, this part of the docs can be used then as a reference.

from documentation.

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.