Giter VIP home page Giter VIP logo

Comments (3)

sbauer322 avatar sbauer322 commented on June 3, 2024

I think this is worthwhile! The main document should focus on Light Table and the Clojure plugin.

Support for the Javascript and Python plugins has been minimal as of late and intermingling the three, as we have done occasionally, is not ideal.

from user-guide.

MarcusE1W avatar MarcusE1W commented on June 3, 2024

I would suggest a top level structure similar to this. The bullet points are to indicate the content, not necessarily sub-levels:

Introduction

  • What is LightTable aimed at.
  • The strongest abilities of LightTable.

Quick Start

  • Quick installtation
  • Load, save, the various views, useful keymappings

Installation

  • Linux
  • Mac
  • PC

Basic functionality

  • open, close, search, all the views and their functionality explained, use of the existiong gifs or create new ones etc..

Advanced functionality

  • Plugin manager, search, find, text folding, compleate list of standard commands and what they do, etc..

Configuration

  • Behaviour setting, many examples,
  • Keymapping, many examples

How to use XXX language with LightTable (a suggestion for a better phrase would be welcome)

  • Clojure
  • Javascript
  • Python
  • Elm (Short introduction and link to Rundis official documentation)
  • Markdown
  • etc (happy to check the plugin list and see what docu is given on their respective github pages)

References

  • Common Terms
  • Complete list of standard commands and what they do
  • Complete list of all standard behaviours and what they do

If the structure is ok I can move the existing content into the new structure.
The next step would be to make the content of each chapter more consistent and rounded
After that new content can be added.

Is that ok?

from user-guide.

sbauer322 avatar sbauer322 commented on June 3, 2024

I think this outline should be suitable and a good improvement.

More of an open ended question that does not need to be answered right now, but for the "How to use XXX language with LightTable" section, perhaps it would make sense to create other separate guides for each plugin and simply link to them?

In any case, we certainly should separate the plugin specific content as you suggested.

from user-guide.

Related Issues (2)

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.