feat: add initial documentation for project structure, purpose, and progress
Signed-off-by: juliano.barbosa <julianomb@gmail.com>
This commit is contained in:
parent
da9ce274c6
commit
a486c5c4b6
5 changed files with 292 additions and 0 deletions
31
cline_docs/productContext.md
Normal file
31
cline_docs/productContext.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# Product Context
|
||||
|
||||
## Purpose
|
||||
Kickstart.nvim is a starting point for Neovim configuration that aims to be:
|
||||
- Small and manageable
|
||||
- Single-file based (though modular options exist)
|
||||
- Completely documented
|
||||
- Educational and customizable
|
||||
|
||||
## Problems Solved
|
||||
1. Provides a quick start for new Neovim users without overwhelming them
|
||||
2. Offers a documented foundation that users can learn from and modify
|
||||
3. Reduces the complexity of initial Neovim setup
|
||||
4. Balances features with simplicity
|
||||
|
||||
## How It Works
|
||||
1. Users clone the repository to their Neovim config directory
|
||||
2. The configuration automatically installs lazy.nvim (plugin manager)
|
||||
3. Core features are loaded through a well-documented init.lua file
|
||||
4. Additional features can be enabled through the plugins system
|
||||
5. Users can extend functionality through custom plugins in lua/custom/plugins/
|
||||
|
||||
## Key Features
|
||||
1. LSP (Language Server Protocol) integration
|
||||
2. Syntax highlighting via Treesitter
|
||||
3. Fuzzy finding with Telescope
|
||||
4. Git integration
|
||||
5. Auto-completion
|
||||
6. File navigation
|
||||
7. Custom keymaps for improved workflow
|
||||
8. Built-in formatting support
|
||||
Loading…
Add table
Add a link
Reference in a new issue