From 53da02b899c3c93e351ef2ddf133e2db95748ef6 Mon Sep 17 00:00:00 2001 From: Alexey Dubovskoy Date: Tue, 5 Nov 2024 09:27:53 +0000 Subject: [PATCH] proposal: draft 0014-shortcodes --- proposals/0014-shortcodes.md | 71 ++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 proposals/0014-shortcodes.md diff --git a/proposals/0014-shortcodes.md b/proposals/0014-shortcodes.md new file mode 100644 index 0000000..b41b40e --- /dev/null +++ b/proposals/0014-shortcodes.md @@ -0,0 +1,71 @@ +# Shortcodes + +* Proposal: [0014-shortcodes](0014-shortcodes.md) +* Authors: [Alexey Dubovskoy](https://github.com/dubadub) +* Status: **Awaiting review** + + +## Introduction + +A short description of what the feature is. Try to keep it to a +single-paragraph "elevator pitch" so the reader understands what +problem this proposal is addressing. + +Discussion thread: nope. + +## Motivation + +Describe the problems that this proposal seeks to address. If the +problem is that some common pattern is currently hard to express, show +how one can currently get a similar effect and describe its +drawbacks. If it's completely new functionality that cannot be +emulated, motivate why this new functionality would help Cooklang community +use Cooklang better. + +## Proposed solution + +Describe your solution to the problem. Provide examples and describe +how they work. Show how your solution is better than current +workarounds (if any). + +## Detailed design + +Describe the design of the solution in detail. If it involves new +syntax in the language, show the additions and changes to the Cooklang +grammar. If it's a new API, show the full API and its documentation +comments detailing what it does. The detail in this section should be +sufficient for someone who is *not* one of the authors to be able to +reasonably implement the feature. + +## Effect on applications which use Cooklang + +Changes in Cooklang syntax often require supplementary UI changes in +apps which use it (otherwise why these changes if nothing will +use them). Describe in details what changes should be implemented. +The detail in this section should be sufficient for someone +who is *not* one of the authors to be able to reasonably implement +the feature. + +### CookCLI (terminal and web-server) + +Does the proposal change the output of +[CookCLI](https://github.com/cooklang/CookCLI)? Does it require adding +a new sub-command to fully use this feature? + +### Mobile applications + +Does the proposal require changes in mobile application UI? Describe +what screens should be changed and how. Give as much details as +possible. + +## Alternatives considered + +Describe alternative approaches to addressing the same problem, and +why you chose this approach instead. + +## Acknowledgments + +If significant changes or improvements suggested by members of the +community were incorporated into the proposal as it developed, take a +moment here to thank them for their contributions. Cooklang evolution is a +collaborative process, and everyone's input should receive recognition!