Comments (3)
I previously wrote sections like this in the README but they were removed by Chris for brevity. Sample here: https://github.com/LunarVim/LunarVim/blob/b3cd29f86369c0f61c467ccea1510b6fb6773c9d/README.md#getting-started
My understanding of the decision for removing these sections is that:
- there's already too much to read
- code examples are preferable to long prose
- it's hard to keep these sections updated as the project changes
- the longer the text, the less likely it is for anyone to actually read it.
That said, I'm all for adding information geared towards newer users as long as it's brief.
from lunarvim.org.
Apologies for the late reply. I personally think the "Getting Started" section makes it much more accessible than the current README. Perhaps a compromise could be reached, with that section being re-added, or with its text featured prominently at the top of the Quick-start page of the website?
from lunarvim.org.
Currently the process for finding the documentation for how to use telescope or nvim-tree, two essential parts of LunarVim's UI, goes a bit like this: Getting Started -> Installation -> Quickstart -> Under "Next Steps", there's a page pointing to plugins, which explains how to configure them -> From here a user could reach Core Plugins List, which links to the documentation.
Imo, this is a rather unintuitive way of learning how to use a program, as:
- It's too many steps, which makes it more likely users will look for help elsewhere (the issues page), when all the relevant documentation is technically on the website already.
- You have to deduce the core UI's function based on their descriptions in a rather long list, instead of being told what does what from the beginning.
- You're taught how to configure components in the program before being shown what they do. Furthermore, many of these components have unintuitive names (telescope), so seeing examples in the configuration doesn't alleviate 2.
IMO, for more advanced things like linters and git integration and such, where the user is likely to open a configuration file to configure project specific options anyway, point 2 is not a problem, there are better ways to convey information, but for their scope it's perfectly fine. However for the built-in aspects of the interface, for what comes bundled with the IDE itself and is necessary to navigate it, it's confusing to have to read through a sub-page to the "plugins" page to understand how, for example, the "open a file" dialogue works, when you aren't familiar with what "telescope" is, and thus can't know whether "teslecope" is a plugin or not.
Summarizing what these key UI components are (and where to find their documentation), in a "Interface & Navigation", or "Using LunarVim", subsection of quickstart, perhaps as a standalone page, would significantly alleviate most of those problems, and make it more accessible for people that aren't already familiar with vim as an IDE.
from lunarvim.org.
Related Issues (20)
- docusaurus: use metadata instead of number prefixes
- Dependency for Telescope: fd HOT 2
- Chinese translation HOT 5
- New docs layout HOT 7
- fix: update glow installation HOT 2
- Include an explanation of what LunarVim is on the website and docs
- Translation problems
- Confusing image at landing page
- Do you still accept document translations? HOT 4
- Example configuration of neoscroll should disable lazy loading HOT 1
- Portuguese translation HOT 2
- Document adding .cargo/bin to $PATH
- Update for for changes in Nerdfont version 3.x HOT 5
- built-in linter documentation
- Lua warning for Scala config HOT 1
- Example minimap config not correct
- Website links to a Manual Install section that does not exist HOT 1
- FAQ request: Why is Lunarvim using an install script? HOT 1
- docs/missing code-actions config in the docs
- configuration instructions should point to starter.lvim
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 lunarvim.org.