Skip to content
This repository was archived by the owner on Apr 16, 2024. It is now read-only.

Commit 276d65b

Browse files
author
connorgmeean
committed
chore(docs): Removed references to deprecated develop branch.
1 parent ad93157 commit 276d65b

File tree

6 files changed

+13
-432
lines changed

6 files changed

+13
-432
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
![License](https://img.shields.io/github/license/NTBBloodbath/doom-nvim?style=for-the-badge)
77
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge)](http://makeapullrequest.com)
88
![Latest Release](https://img.shields.io/github/v/release/NTBBloodbath/doom-nvim?include_prereleases&style=for-the-badge&color=red)
9-
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/NTBBloodbath/doom-nvim/develop?style=for-the-badge)
10-
![Neovim version](https://img.shields.io/badge/Neovim-0.5-57A143?style=for-the-badge&logo=neovim)
9+
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/NTBBloodbath/doom-nvim/main?style=for-the-badge)
10+
![Neovim version](https://img.shields.io/badge/Neovim-0.7-57A143?style=for-the-badge&logo=neovim)
1111
[![Discord](https://img.shields.io/badge/discord-join-7289da?style=for-the-badge&logo=discord)](https://discord.gg/xhvBM45zBf)
1212

1313
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

docs/README.md

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,17 @@
11
# Doom Nvim Documentation
22

3-
Doom Nvim is a port to Neovim of the [Doom Emacs](https://github.com/hlissner/doom-emacs)
4-
configuration framework for [GNU Emacs](https://www.gnu.org/software/emacs/) adapted
5-
for all vimmer who want less framework in their framework and the performance of
6-
a handmade configuration (or better). It can be a base for your own setup or a
7-
resource for Neovim enthusiasts to learn more about our favorite editor and how to
8-
do X things on it by using Lua.
9-
10-
Doom Nvim is an opinionated collection of reasonable (and optional) defaults with
11-
a focus on performance (both runtime and startup) and on abstraction-light, readable
12-
code design, so that there is less between you and Neovim.
13-
143
> The documentation is designed to be viewed within Doom Nvim. Access it by pressing
154
> `:h doom_nvim`.
165
176
## Documentation
187

19-
### Getting Started
20-
21-
- [Install](./getting_started.md#install)
22-
- [Update & Rollback](./getting_started.md#update--rollback)
23-
- [Configuration](./getting_started.md#configuration)
24-
25-
### Modules
26-
27-
- [Introduction](./modules.md#introduction)
28-
- [Tweaking Doom Nvim Modules](./modules.md#tweaking-doom-nvim-modules)
8+
- [All Modules](./modules.md#all-modules)
9+
- [Configuring modules](./modules.md#quick-guide)
10+
- [Buidling/contributing your own modules](./modules.md#building-your-own-module)
11+
- [API Reference](./api.md) :warning: Not yet implemented. Refer to comments in [doom_global.lua](../lua/doom/core/doom_global.lua)
2912

3013
### Contributing
3114

32-
- [Where can I help?](./contributing.md#where-can-i-help)
3315
- [Reporting issues](./contributing.md#reporting-issues)
3416
- [Suggesting features, keybinds and enhancements](./contributing.md#suggesting-features-keybinds-and-enhancements)
3517
- [Contributing code](./contributing.md#contributing-code)
@@ -39,7 +21,3 @@ code design, so that there is less between you and Neovim.
3921
### Asking for help
4022

4123
- [Our issues tracker](https://github.com/NTBBloodbath/doom-nvim/issues)
42-
43-
### Projects
44-
45-
- [Projects](https://github.com/NTBBloodbath/doom-nvim/projects)

docs/contributing.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,7 @@ quote_style = "AutoPreferDouble"
100100
101101
#### Commits & PRs
102102

103-
- Target `develop` instead of `main`.
104-
The only exception are hotfixes (plugins breaking changes, Doom bugs)
105-
and documentation improvements!
103+
- Target the `main` branch.
106104

107105
#### Keybind conventions
108106

docs/faq.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)