Coder Social home page Coder Social logo

Table of Content about specification HOT 6 OPEN

rakus avatar rakus commented on July 21, 2024 2
Table of Content

from specification.

Comments (6)

cxw42 avatar cxw42 commented on July 21, 2024 1

As far as I know, this repo was driven by questions from plugin developers. I think the existing web site does a good job for user-level documentaiton.

from specification.

xuhdev avatar xuhdev commented on July 21, 2024 1

@cxw42 It seems like most of the content is also applicable to general use (e.g., what is a property when a user sees a list of supported properties?). Since clarifying these matters also helps many users (while they may not raise questions), I think it makes sense to separate them with developer-specific content, at least textually, so that users can avoid the trouble reading them.

from specification.

xuhdev avatar xuhdev commented on July 21, 2024 1

I've updated the content. Would you like to check it out?

from specification.

cxw42 avatar cxw42 commented on July 21, 2024 1

Can this issue now be closed?

from specification.

xuhdev avatar xuhdev commented on July 21, 2024

I agree with these. We probably also want a definition subsection that defines several concepts, such as "properties," "values," etc. in File Format. I also think the last section for plugin developers should be moved to a page specifically written for developers (Pure users do not need to read the last section).

from specification.

rakus avatar rakus commented on July 21, 2024

Hmm --- This raises the question: Do we write specs to be read by developer who want to develop editorconfig support for a editor/ide etc or do we want to write a user documentation?

from specification.

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.