From d6db202a0391205532a68a6680c40849c6856a85 Mon Sep 17 00:00:00 2001 From: Kent Daleng Date: Mon, 18 Aug 2025 08:00:28 +0200 Subject: wiki/docs: rename index.md to README.md --- docs/mkdocs.yaml | 2 +- docs/wiki/README.md | 11 +++++++++++ docs/wiki/index.md | 11 ----------- 3 files changed, 12 insertions(+), 12 deletions(-) create mode 100644 docs/wiki/README.md delete mode 100644 docs/wiki/index.md (limited to 'docs') diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml index cbd323ad..7130c329 100644 --- a/docs/mkdocs.yaml +++ b/docs/mkdocs.yaml @@ -64,7 +64,7 @@ validation: not_in_nav: | _Sidebar.md Configuration:-Overview.md - index.md + README.md # ah, wouldn't it be nice if we could autogenerate this with wiki/_Sidebar.md nav: - Usage: diff --git a/docs/wiki/README.md b/docs/wiki/README.md new file mode 100644 index 00000000..98adb2b5 --- /dev/null +++ b/docs/wiki/README.md @@ -0,0 +1,11 @@ +Welcome to the niri documentation! + +Feel free to look through usage and [Getting started](./Getting-Started.md). +If you're looking for ways to configure niri, check out the [introduction to configuration](./Configuration:-Introduction.md). +If you want to contribute to niri, look at the development section and [how to develop niri](./Development:-Developing-niri.md). + +If you're not already here, check out our new wiki website! https://yalter.github.io/niri/ + +--- + +The documentation is open to contribution, but please discuss bigger changes in [our Matrix room](https://matrix.to/#/#niri:matrix.org) first! The wiki is generated from files in the `docs/wiki/` folder of the repository, so you can open a pull request modifying it there. diff --git a/docs/wiki/index.md b/docs/wiki/index.md deleted file mode 100644 index 98adb2b5..00000000 --- a/docs/wiki/index.md +++ /dev/null @@ -1,11 +0,0 @@ -Welcome to the niri documentation! - -Feel free to look through usage and [Getting started](./Getting-Started.md). -If you're looking for ways to configure niri, check out the [introduction to configuration](./Configuration:-Introduction.md). -If you want to contribute to niri, look at the development section and [how to develop niri](./Development:-Developing-niri.md). - -If you're not already here, check out our new wiki website! https://yalter.github.io/niri/ - ---- - -The documentation is open to contribution, but please discuss bigger changes in [our Matrix room](https://matrix.to/#/#niri:matrix.org) first! The wiki is generated from files in the `docs/wiki/` folder of the repository, so you can open a pull request modifying it there. -- cgit