5 Commits (04622300608e479e3826e8476ff735d38345bb81)

Author	SHA1	Message	Date
Gergely Nagy	717626ad18	doc/plugin/: Update all the example references ... The examples were recently reorganized, but the documentation was not updated, so some of them were pointing to dangling, obsolete places. This updates them all to point to the correct locations. Signed-off-by: Gergely Nagy <algernon@keyboard.io>	6 years ago
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	5319898e78	MagicCombo: Document that the old API error message will be removed ... I chose the date to be the same as the removal date of other compatibility stuff recently introduced, so we'll only have one flag day. We could remove it earlier, because the error was there for a while now, but I'd rather play it safe. Fixes #374. Signed-off-by: Gergely Nagy <algernon@keyboard.io>	6 years ago
Gergely Nagy	f83b1c2b87	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	d3e7364ac7	Rearrange the file layout in preparation of becoming a monorepo ... Move the documentation to `doc/plugin/MagicCombo.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