Comments (6)
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.
@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.
I've updated the content. Would you like to check it out?
from specification.
Can this issue now be closed?
from specification.
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.
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)
- Clarify behavior of trim_trailing_whitespace HOT 6
- Tell IDE to ignore files HOT 3
- Enhancement: Light comment style preference HOT 2
- Clarify behavior of formatting (non-"root") properties at top level HOT 10
- Versioning with SemVer HOT 2
- Introduce AST + validation errors HOT 21
- Clarification on insert_final_newline behavior for empty files HOT 3
- Clarify the behavior of leading slash in section title HOT 2
- Clarify behavior of ; and # within values HOT 14
- max_line_length is not specified HOT 15
- Readthedocs link mentioned in README.md not available HOT 4
- [Title]
- Odd grammatical syntax at supported-properties/root HOT 1
- Use editorconfig.org subdomain HOT 3
- How to have a multiline value HOT 2
- Clarify 'key containing whitespace' case HOT 8
- version tags? HOT 1
- Clarify glob matching HOT 7
- Clarify that spelling_language strings must be exactly two or five characters HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from specification.