misc: remove the docs and examples submodules

They have not been correctly updated in lock-step for a while now.
This commit is contained in:
outfoxxed 2024-06-02 15:23:19 -07:00
parent bd504daf56
commit 7d20b472dd
Signed by: outfoxxed
GPG Key ID: 4C88A185FB89301E
6 changed files with 5 additions and 22 deletions

4
.gitignore vendored
View File

@ -1,3 +1,7 @@
# related repos
/docs
/examples
# build files
/result
/build/

6
.gitmodules vendored
View File

@ -1,6 +0,0 @@
[submodule "docs"]
path = docs
url = https://git.outfoxxed.me/outfoxxed/quickshell-docs
[submodule "examples"]
path = examples
url = https://git.outfoxxed.me/outfoxxed/quickshell-examples

View File

@ -60,7 +60,7 @@ cannot handle random line breaks and will usually require you to disable clang-f
lines are too long.
Before submitting an MR, if adding new features please make sure the documentation is generated
reasonably using the `quickshell-docs` repo.
reasonably using the `quickshell-docs` repo. We recommend checking it out at `/docs` in this repo.
Doc comments take the form `///` or `///!` (summary) and work with markdown.
Look at existing code for how it works.

View File

@ -14,19 +14,6 @@ can be built from the [quickshell-docs](https://git.outfoxxed.me/outfoxxed/quick
Some fully working examples can be found in the [quickshell-examples](https://git.outfoxxed.me/outfoxxed/quickshell-examples)
repo.
Both the documentation and examples are included as submodules with revisions that work with the current
version of quickshell.
You can clone everything with
```
$ git clone --recursive https://git.outfoxxed.me/outfoxxed/quickshell.git
```
Or clone missing submodules later with
```
$ git submodule update --init --recursive
```
# Installation
## Nix

1
docs

@ -1 +0,0 @@
Subproject commit ff5da84a8b258a9b2caaf978ddb6de23635d8903

@ -1 +0,0 @@
Subproject commit b9e744b50673304dfddb68f3da2a2e906d028b96