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 committed 2024-06-02 15:23:19 -07:00
1 parent bd504daf56
commit 7d20b472dd
6 files changed
+5 -22

No files matched your search

+4
View File
@@ -1,3 +1,7 @@
# related repos
/docs
/examples
# build files # build files
/result /result
/build/ /build/
-6
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
+1 -1
View File
@@ -60,7 +60,7 @@ cannot handle random line breaks and will usually require you to disable clang-f
lines are too long. lines are too long.
Before submitting an MR, if adding new features please make sure the documentation is generated 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. Doc comments take the form `///` or `///!` (summary) and work with markdown.
Look at existing code for how it works. Look at existing code for how it works.
-13
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) Some fully working examples can be found in the [quickshell-examples](https://git.outfoxxed.me/outfoxxed/quickshell-examples)
repo. 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 # Installation
## Nix ## Nix
Submodule docs deleted from ff5da84a8b.
Submodule examples deleted from b9e744b506.