Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New docs layout #352

Closed
9 tasks
LostNeophyte opened this issue Jan 15, 2023 · 7 comments · Fixed by #355
Closed
9 tasks

New docs layout #352

LostNeophyte opened this issue Jan 15, 2023 · 7 comments · Fixed by #355
Assignees

Comments

@LostNeophyte
Copy link
Member

LostNeophyte commented Jan 15, 2023

Plan for a new layout:

# Installation
  - [new] Post install ($PATH, nerd fonts)
# Beginner's guide
  - [new] Terminology (what's LSP, treesitter, autocmds)
  - [new] Plugins overview (most important ones)
  - Keybinds overview  
# Configuration
  - [new] Options (vim.opt, vim.g)
  - Keybindings
  - Plugins
    - [new] Core plugins (lvim.builtin)
    - [new] User plugins (lvim.plugins)
    - Example configurations (current `plugins/extra-plugins.md`)
  - Appearance (no readme.md)
    - Colorschemes
    - Statusline
  - LSP (current `languages/README.md`) TODO: better name for the section
  - Snippets
  - Autocommands
  - Ftplugin
# [new/needs update] FAQ
# Troubleshooting
# Features
  - Supported languages (current languages)
    - ...
  - Supported frameworks (current frameworks)
    - ...
# community
  - Meet the team

todo list

fixes #217, #251

@apoorvapendse
Copy link
Contributor

Can i help you write the plugins overview?

@LostNeophyte
Copy link
Member Author

@apoorvapendse
it's already written in the master version of the docs (https://www.lunarvim.org/docs/master/beginners-guide/plugins-overview)
however it does have an error, NERDtree is in there, it should be nvimtree. you can improve the page if you want, I intended it to be mostly for ui plugins so that a new user know what they're looking at
thanks

@apoorvapendse
Copy link
Contributor

you mean just the typo?

@LostNeophyte
Copy link
Member Author

typo and whatever you want

@apoorvapendse
Copy link
Contributor

alright i'll create a PR in 5 mins

@apoorvapendse
Copy link
Contributor

done #424

@etleyden
Copy link

For the plugins overview, does anyone think there should be links to those repositories, so readers can see more documentation on those plugins?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants