Kaleidoscope

Commit Graph

Author	SHA1	Message	Date
Gergely Nagy	82a70ee1c5	docs: Introduce NEWS.md, merge all upgrade notes into UPGRADING.md For easier navigation of changes, this introduces `NEWS.md`, a high-level overview of important or otherwise noteworthy changes. It is a short list only, with just the bare minimum of details. The new `UPGRADING.md` on the other hand, is a much more detailed document, and contains the upgrade notes from plugins too. The plugin docs now document the current version of the plugins only. The intent is to have both a short overview (`NEWS.md`), and a detailed guide (`UPGRADING.md`). The former will contain historical entries too, while the later is meant to be an upgrade guide from the previous version to the most recent one, with old notes eventually removed. Fixes #436. Signed-off-by: Gergely Nagy <algernon@keyboard.io>	6 years ago
Gergely Nagy	8bac58bf09	Update the documentation links Updates the example and dependency links in the documentation, to use URLs that are valid within the monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>	6 years ago
Gergely Nagy	3a7be52642	Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/LEDEffect-SolidColor.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>	6 years ago

Author

SHA1

Message

Date

Gergely Nagy

82a70ee1c5

docs: Introduce NEWS.md, merge all upgrade notes into UPGRADING.md

For easier navigation of changes, this introduces `NEWS.md`, a high-level
overview of important or otherwise noteworthy changes. It is a short list only,
with just the bare minimum of details. The new `UPGRADING.md` on the other hand,
is a much more detailed document, and contains the upgrade notes from plugins
too. The plugin docs now document the current version of the plugins only.

The intent is to have both a short overview (`NEWS.md`), and a detailed
guide (`UPGRADING.md`). The former will contain historical entries too, while
the later is meant to be an upgrade guide from the previous version to the most
recent one, with old notes eventually removed.

Fixes #436.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>

Gergely Nagy

8bac58bf09

Update the documentation links

Updates the example and dependency links in the documentation, to use URLs that
are valid within the monorepo.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>

Gergely Nagy

3a7be52642

Rearrange the file layout in preparation of becoming a monorepo

Move the documentation to `doc/plugin/LEDEffect-SolidColor.md`, sources under
`src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of
merging plugins into a single monorepo.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>

3 Commits (dbaba6c1ef068aa34a0a7970494594b0a80ae9bd)