Code Monkey home page Code Monkey logo

Comments (3)

waldyrious avatar waldyrious commented on August 17, 2024

The idea is great! Essentially we'd make the storage of command pages distributed. There are some points we might need to iron out:

  1. we need a definitive format for the TLDR pages. I've been mulling on a proposal to change the pages' syntax (tldr-pages/tldr#958), but we could start with the current syntax as a 1.0 spec, eventually updating it with the proposals shown in https://github.com/tldr-pages/tldr/labels/syntax
  2. we do already have several tools that don't come bundled with any Unix distro. I don't think having a large repo would be too problematic, as it's mostly small text files. However, we will indeed end up bumping into naming conflicts if we just keep growing indiscriminately, so either agreeing on explicit requirements for inclusion, or swapping to a namespaced approach (e.g. user/repo) will probably be needed. Again, this doesn't preclude this feature to be implemented, but we will have to make a decision sooner or later.

As for the downsides, I don't understand the first one; the second is not a problem IMO -- we could e.g. add a disclaimer to the top of the page if the content isn't being loaded from the tldr-pages project.

from tldr.jsx.

leostera avatar leostera commented on August 17, 2024

On the downsides, the first one means that it wouldn't be able to suggest commands as alternatives because it doesn't know they exist. Say you look for windows/du and it can't find it, but it can find linux/du in the index. If a command is not in the index, then it can't be shown as an alternative.

from tldr.jsx.

waldyrious avatar waldyrious commented on August 17, 2024

We could use that as an opportunity to prompt people to contribute the missing commands, like the current node client does :)

from tldr.jsx.

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.