From 7925fc6cafb0c0884a9b51a7d2ab5798112e7029 Mon Sep 17 00:00:00 2001 From: Aaron Po Date: Mon, 27 Apr 2026 18:05:59 -0400 Subject: [PATCH] Format all markdown files in active directories --- .github/ISSUE_TEMPLATE/feature_request.md | 22 +- LICENSE.md | 962 +++++++++----------- README.md | 46 +- docs/architecture.md | 37 +- docs/docker.md | 29 +- docs/environment-variables.md | 34 +- docs/getting-started.md | 9 +- docs/testing.md | 25 +- docs/token-validation.md | 36 +- tooling/pipeline/ETHICS-AND-KNOWN-ISSUES.md | 32 +- tooling/pipeline/prompts/system.md | 102 ++- 11 files changed, 693 insertions(+), 641 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 18b8de6..4fb81c2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,6 +7,7 @@ assignees: [] --- ## User Story + **As a** (who wants to accomplish something) **I want to** (what they want to accomplish) **So that** (why they want to accomplish that thing) @@ -15,29 +16,18 @@ assignees: [] ### Scenario 1 - -Given ... -When ... -Then ... - +Given ... When ... Then ... ### Scenario 2 - -Given ... -When ... -Then ... - +Given ... When ... Then ... ### Scenario 3 - -Given ... -When ... -Then ... - +Given ... When ... Then ... ## Subtasks + - [ ] Task 1 - [ ] Task 2 -- [ ] Task 3 \ No newline at end of file +- [ ] Task 3 diff --git a/LICENSE.md b/LICENSE.md index 496acdb..a6882fc 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -2,76 +2,69 @@ Version 3, 29 June 2007 -Copyright (C) 2007 Free Software Foundation, Inc. - +Copyright (C) 2007 Free Software Foundation, Inc. -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. ## Preamble -The GNU General Public License is a free, copyleft license for -software and other kinds of works. +The GNU General Public License is a free, copyleft license for software and +other kinds of works. -The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom -to share and change all versions of a program--to make sure it remains -free software for all its users. We, the Free Software Foundation, use -the GNU General Public License for most of our software; it applies -also to any other work released this way by its authors. You can apply -it to your programs, too. +The licenses for most software and other practical works are designed to take +away your freedom to share and change the works. By contrast, the GNU General +Public License is intended to guarantee your freedom to share and change all +versions of a program--to make sure it remains free software for all its users. +We, the Free Software Foundation, use the GNU General Public License for most of +our software; it applies also to any other work released this way by its +authors. You can apply it to your programs, too. -When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for them if you wish), that you +receive source code or can get it if you want it, that you can change the +software or use pieces of it in new free programs, and that you know you can do +these things. -To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you -have certain responsibilities if you distribute copies of the -software, or if you modify it: responsibilities to respect the freedom -of others. +To protect your rights, we need to prevent others from denying you these rights +or asking you to surrender the rights. Therefore, you have certain +responsibilities if you distribute copies of the software, or if you modify it: +responsibilities to respect the freedom of others. -For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. +For example, if you distribute copies of such a program, whether gratis or for a +fee, you must pass on to the recipients the same freedoms that you received. You +must make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. -Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. +Developers that use the GNU GPL protect your rights with two steps: (1) assert +copyright on the software, and (2) offer you this License giving you legal +permission to copy, distribute and/or modify it. -For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. +For the developers' and authors' protection, the GPL clearly explains that there +is no warranty for this free software. For both users' and authors' sake, the +GPL requires that modified versions be marked as changed, so that their problems +will not be attributed erroneously to authors of previous versions. -Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the -manufacturer can do so. This is fundamentally incompatible with the -aim of protecting users' freedom to change the software. The -systematic pattern of such abuse occurs in the area of products for -individuals to use, which is precisely where it is most unacceptable. -Therefore, we have designed this version of the GPL to prohibit the -practice for those products. If such problems arise substantially in -other domains, we stand ready to extend this provision to those -domains in future versions of the GPL, as needed to protect the -freedom of users. +Some devices are designed to deny users access to install or run modified +versions of the software inside them, although the manufacturer can do so. This +is fundamentally incompatible with the aim of protecting users' freedom to +change the software. The systematic pattern of such abuse occurs in the area of +products for individuals to use, which is precisely where it is most +unacceptable. Therefore, we have designed this version of the GPL to prohibit +the practice for those products. If such problems arise substantially in other +domains, we stand ready to extend this provision to those domains in future +versions of the GPL, as needed to protect the freedom of users. -Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish -to avoid the special danger that patents applied to a free program -could make it effectively proprietary. To prevent this, the GPL -assures that patents cannot be used to render the program non-free. +Finally, every program is threatened constantly by software patents. States +should not allow patents to restrict development and use of software on +general-purpose computers, but in those that do, we wish to avoid the special +danger that patents applied to a free program could make it effectively +proprietary. To prevent this, the GPL assures that patents cannot be used to +render the program non-free. -The precise terms and conditions for copying, distribution and -modification follow. +The precise terms and conditions for copying, distribution and modification +follow. ## TERMS AND CONDITIONS @@ -79,556 +72,501 @@ modification follow. "This License" refers to version 3 of the GNU General Public License. -"Copyright" also means copyright-like laws that apply to other kinds -of works, such as semiconductor masks. +"Copyright" also means copyright-like laws that apply to other kinds of works, +such as semiconductor masks. -"The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. +"The Program" refers to any copyrightable work licensed under this License. Each +licensee is addressed as "you". "Licensees" and "recipients" may be individuals +or organizations. -To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of -an exact copy. The resulting work is called a "modified version" of -the earlier work or a work "based on" the earlier work. +To "modify" a work means to copy from or adapt all or part of the work in a +fashion requiring copyright permission, other than the making of an exact copy. +The resulting work is called a "modified version" of the earlier work or a work +"based on" the earlier work. -A "covered work" means either the unmodified Program or a work based -on the Program. +A "covered work" means either the unmodified Program or a work based on the +Program. -To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. +To "propagate" a work means to do anything with it that, without permission, +would make you directly or secondarily liable for infringement under applicable +copyright law, except executing it on a computer or modifying a private copy. +Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as well. -To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user -through a computer network, with no transfer of a copy, is not -conveying. +To "convey" a work means any kind of propagation that enables other parties to +make or receive copies. Mere interaction with a user through a computer network, +with no transfer of a copy, is not conveying. -An interactive user interface displays "Appropriate Legal Notices" to -the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a +An interactive user interface displays "Appropriate Legal Notices" to the extent +that it includes a convenient and prominently visible feature that (1) displays +an appropriate copyright notice, and (2) tells the user that there is no +warranty for the work (except to the extent that warranties are provided), that +licensees may convey the work under this License, and how to view a copy of this +License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. ### 1. Source Code. -The "source code" for a work means the preferred form of the work for -making modifications to it. "Object code" means any non-source form of -a work. +The "source code" for a work means the preferred form of the work for making +modifications to it. "Object code" means any non-source form of a work. -A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. +A "Standard Interface" means an interface that either is an official standard +defined by a recognized standards body, or, in the case of interfaces specified +for a particular programming language, one that is widely used among developers +working in that language. -The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. +The "System Libraries" of an executable work include anything, other than the +work as a whole, that (a) is included in the normal form of packaging a Major +Component, but which is not part of that Major Component, and (b) serves only to +enable use of the work with that Major Component, or to implement a Standard +Interface for which an implementation is available to the public in source code +form. A "Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system (if any) on +which the executable work runs, or a compiler used to produce the work, or an +object code interpreter used to run it. -The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. +The "Corresponding Source" for a work in object code form means all the source +code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. +However, it does not include the work's System Libraries, or general-purpose +tools or generally available free programs which are used unmodified in +performing those activities but which are not part of the work. For example, +Corresponding Source includes interface definition files associated with source +files for the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, such as by +intimate data communication or control flow between those subprograms and other +parts of the work. -The Corresponding Source need not include anything that users can -regenerate automatically from other parts of the Corresponding Source. +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. -The Corresponding Source for a work in source code form is that same -work. +The Corresponding Source for a work in source code form is that same work. ### 2. Basic Permissions. -All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. +All rights granted under this License are granted for the term of copyright on +the Program, and are irrevocable provided the stated conditions are met. This +License explicitly affirms your unlimited permission to run the unmodified +Program. The output from running a covered work is covered by this License only +if the output, given its content, constitutes a covered work. This License +acknowledges your rights of fair use or other equivalent, as provided by +copyright law. -You may make, run and propagate covered works that you do not convey, -without conditions so long as your license otherwise remains in force. -You may convey covered works to others for the sole purpose of having -them make modifications exclusively for you, or provide you with -facilities for running those works, provided that you comply with the -terms of this License in conveying all material for which you do not -control copyright. Those thus making or running the covered works for -you must do so exclusively on your behalf, under your direction and -control, on terms that prohibit them from making any copies of your -copyrighted material outside their relationship with you. +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey +covered works to others for the sole purpose of having them make modifications +exclusively for you, or provide you with facilities for running those works, +provided that you comply with the terms of this License in conveying all +material for which you do not control copyright. Those thus making or running +the covered works for you must do so exclusively on your behalf, under your +direction and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. -Conveying under any other circumstances is permitted solely under the -conditions stated below. Sublicensing is not allowed; section 10 makes -it unnecessary. +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. -No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. +No covered work shall be deemed part of an effective technological measure under +any applicable law fulfilling obligations under article 11 of the WIPO copyright +treaty adopted on 20 December 1996, or similar laws prohibiting or restricting +circumvention of such measures. When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such -circumvention is effected by exercising rights under this License with -respect to the covered work, and you disclaim any intention to limit -operation or modification of the work as a means of enforcing, against -the work's users, your or third parties' legal rights to forbid -circumvention of technological measures. +circumvention of technological measures to the extent such circumvention is +effected by exercising rights under this License with respect to the covered +work, and you disclaim any intention to limit operation or modification of the +work as a means of enforcing, against the work's users, your or third parties' +legal rights to forbid circumvention of technological measures. ### 4. Conveying Verbatim Copies. -You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all +You may convey verbatim copies of the Program's source code as you receive it, +in any medium, provided that you conspicuously and appropriately publish on each +copy an appropriate copyright notice; keep intact all notices stating that this +License and any non-permissive terms added in accord with section 7 apply to the +code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. -You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. +You may charge any price or no price for each copy that you convey, and you may +offer support or warranty protection for a fee. ### 5. Conveying Modified Source Versions. -You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these -conditions: +You may convey a work based on the Program, or the modifications to produce it +from the Program, in the form of source code under the terms of section 4, +provided that you also meet all of these conditions: -- a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. -- b) The work must carry prominent notices stating that it is - released under this License and any conditions added under - section 7. This requirement modifies the requirement in section 4 - to "keep intact all notices". -- c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. -- d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. +- a) The work must carry prominent notices stating that you modified it, and + giving a relevant date. +- b) The work must carry prominent notices stating that it is released under + this License and any conditions added under section 7. This requirement + modifies the requirement in section 4 to "keep intact all notices". +- c) You must license the entire work, as a whole, under this License to anyone + who comes into possession of a copy. This License will therefore apply, along + with any applicable section 7 additional terms, to the whole of the work, and + all its parts, regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not invalidate + such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display Appropriate + Legal Notices; however, if the Program has interactive interfaces that do not + display Appropriate Legal Notices, your work need not make them do so. -A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other +A compilation of a covered work with other separate and independent works, which +are not by their nature extensions of the covered work, and which are not +combined with it such as to form a larger program, in or on a volume of a +storage or distribution medium, is called an "aggregate" if the compilation and +its resulting copyright are not used to limit the access or legal rights of the +compilation's users beyond what the individual works permit. Inclusion of a +covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. ### 6. Conveying Non-Source Forms. -You may convey a covered work in object code form under the terms of -sections 4 and 5, provided that you also convey the machine-readable -Corresponding Source under the terms of this License, in one of these -ways: +You may convey a covered work in object code form under the terms of sections 4 +and 5, provided that you also convey the machine-readable Corresponding Source +under the terms of this License, in one of these ways: -- a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. -- b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the Corresponding - Source from a network server at no charge. -- c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. -- d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. -- e) Convey the object code using peer-to-peer transmission, - provided you inform other peers where the object code and - Corresponding Source of the work are being offered to the general - public at no charge under subsection 6d. +- a) Convey the object code in, or embodied in, a physical product (including a + physical distribution medium), accompanied by the Corresponding Source fixed + on a durable physical medium customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product (including a + physical distribution medium), accompanied by a written offer, valid for at + least three years and valid for as long as you offer spare parts or customer + support for that product model, to give anyone who possesses the object code + either (1) a copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical medium + customarily used for software interchange, for a price no more than your + reasonable cost of physically performing this conveying of source, or (2) + access to copy the Corresponding Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the written + offer to provide the Corresponding Source. This alternative is allowed only + occasionally and noncommercially, and only if you received the object code + with such an offer, in accord with subsection 6b. +- d) Convey the object code by offering access from a designated place (gratis + or for a charge), and offer equivalent access to the Corresponding Source in + the same way through the same place at no further charge. You need not require + recipients to copy the Corresponding Source along with the object code. If the + place to copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) that supports + equivalent copying facilities, provided you maintain clear directions next to + the object code saying where to find the Corresponding Source. Regardless of + what server hosts the Corresponding Source, you remain obligated to ensure + that it is available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, provided you inform + other peers where the object code and Corresponding Source of the work are + being offered to the general public at no charge under subsection 6d. -A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. +A separable portion of the object code, whose source code is excluded from the +Corresponding Source as a System Library, need not be included in conveying the +object code work. -A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, -family, or household purposes, or (2) anything designed or sold for -incorporation into a dwelling. In determining whether a product is a -consumer product, doubtful cases shall be resolved in favor of -coverage. For a particular product received by a particular user, -"normally used" refers to a typical or common use of that class of -product, regardless of the status of the particular user or of the way -in which the particular user actually uses, or expects or is expected -to use, the product. A product is a consumer product regardless of -whether the product has substantial commercial, industrial or -non-consumer uses, unless such uses represent the only significant -mode of use of the product. +A "User Product" is either (1) a "consumer product", which means any tangible +personal property which is normally used for personal, family, or household +purposes, or (2) anything designed or sold for incorporation into a dwelling. In +determining whether a product is a consumer product, doubtful cases shall be +resolved in favor of coverage. For a particular product received by a particular +user, "normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way in which +the particular user actually uses, or expects or is expected to use, the +product. A product is a consumer product regardless of whether the product has +substantial commercial, industrial or non-consumer uses, unless such uses +represent the only significant mode of use of the product. -"Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to -install and execute modified versions of a covered work in that User -Product from a modified version of its Corresponding Source. The -information must suffice to ensure that the continued functioning of -the modified object code is in no case prevented or interfered with -solely because modification has been made. +"Installation Information" for a User Product means any methods, procedures, +authorization keys, or other information required to install and execute +modified versions of a covered work in that User Product from a modified version +of its Corresponding Source. The information must suffice to ensure that the +continued functioning of the modified object code is in no case prevented or +interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). +specifically for use in, a User Product, and the conveying occurs as part of a +transaction in which the right of possession and use of the User Product is +transferred to the recipient in perpetuity or for a fixed term (regardless of +how the transaction is characterized), the Corresponding Source conveyed under +this section must be accompanied by the Installation Information. But this +requirement does not apply if neither you nor any third party retains the +ability to install modified object code on the User Product (for example, the +work has been installed in ROM). The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or -updates for a work that has been modified or installed by the -recipient, or for the User Product in which it has been modified or -installed. Access to a network may be denied when the modification -itself materially and adversely affects the operation of the network -or violates the rules and protocols for communication across the -network. +requirement to continue to provide support service, warranty, or updates for a +work that has been modified or installed by the recipient, or for the User +Product in which it has been modified or installed. Access to a network may be +denied when the modification itself materially and adversely affects the +operation of the network or violates the rules and protocols for communication +across the network. -Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. +Corresponding Source conveyed, and Installation Information provided, in accord +with this section must be in a format that is publicly documented (and with an +implementation available to the public in source code form), and must require no +special password or key for unpacking, reading or copying. ### 7. Additional Terms. -"Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. +"Additional permissions" are terms that supplement the terms of this License by +making exceptions from one or more of its conditions. Additional permissions +that are applicable to the entire Program shall be treated as though they were +included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part may +be used separately under those permissions, but the entire Program remains +governed by this License without regard to the additional permissions. -When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when +you modify the work.) You may place additional permissions on material, added by +you to a covered work, for which you have or can give appropriate copyright +permission. -Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders -of that material) supplement the terms of this License with terms: +Notwithstanding any other provision of this License, for material you add to a +covered work, you may (if authorized by the copyright holders of that material) +supplement the terms of this License with terms: -- a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or -- b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or -- c) Prohibiting misrepresentation of the origin of that material, - or requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or -- d) Limiting the use for publicity purposes of names of licensors - or authors of the material; or -- e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or -- f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions - of it) with contractual assumptions of liability to the recipient, - for any liability that these contractual assumptions directly - impose on those licensors and authors. +- a) Disclaiming warranty or limiting liability differently from the terms of + sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or author + attributions in that material or in the Appropriate Legal Notices displayed by + works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, or requiring + that modified versions of such material be marked in reasonable ways as + different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors or authors of + the material; or +- e) Declining to grant rights under trademark law for use of some trade names, + trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that material by + anyone who conveys the material (or modified versions of it) with contractual + assumptions of liability to the recipient, for any liability that these + contractual assumptions directly impose on those licensors and authors. -All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. +All other non-permissive additional terms are considered "further restrictions" +within the meaning of section 10. If the Program as you received it, or any part +of it, contains a notice stating that it is governed by this License along with +a term that is a further restriction, you may remove that term. If a license +document contains a further restriction but permits relicensing or conveying +under this License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does not survive +such relicensing or conveying. -If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. +If you add terms to a covered work in accord with this section, you must place, +in the relevant source files, a statement of the additional terms that apply to +those files, or a notice indicating where to find the applicable terms. -Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; the -above requirements apply either way. +Additional terms, permissive or non-permissive, may be stated in the form of a +separately written license, or stated as exceptions; the above requirements +apply either way. ### 8. Termination. -You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). +You may not propagate or modify a covered work except as expressly provided +under this License. Any attempt otherwise to propagate or modify it is void, and +will automatically terminate your rights under this License (including any +patent licenses granted under the third paragraph of section 11). -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. +However, if you cease all violation of this License, then your license from a +particular copyright holder is reinstated (a) provisionally, unless and until +the copyright holder explicitly and finally terminates your license, and (b) +permanently, if the copyright holder fails to notify you of the violation by +some reasonable means prior to 60 days after the cessation. -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. +Moreover, your license from a particular copyright holder is reinstated +permanently if the copyright holder notifies you of the violation by some +reasonable means, this is the first time you have received notice of violation +of this License (for any work) from that copyright holder, and you cure the +violation prior to 30 days after your receipt of the notice. -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. +Termination of your rights under this section does not terminate the licenses of +parties who have received copies or rights from you under this License. If your +rights have been terminated and not permanently reinstated, you do not qualify +to receive new licenses for the same material under section 10. ### 9. Acceptance Not Required for Having Copies. -You are not required to accept this License in order to receive or run -a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. +You are not required to accept this License in order to receive or run a copy of +the Program. Ancillary propagation of a covered work occurring solely as a +consequence of using peer-to-peer transmission to receive a copy likewise does +not require acceptance. However, nothing other than this License grants you +permission to propagate or modify any covered work. These actions infringe +copyright if you do not accept this License. Therefore, by modifying or +propagating a covered work, you indicate your acceptance of this License to do +so. ### 10. Automatic Licensing of Downstream Recipients. -Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. +Each time you convey a covered work, the recipient automatically receives a +license from the original licensors, to run, modify and propagate that work, +subject to this License. You are not responsible for enforcing compliance by +third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. +organization, or merging organizations. If propagation of a covered work results +from an entity transaction, each party to that transaction who receives a copy +of the work also receives whatever licenses to the work the party's predecessor +in interest had or could give under the previous paragraph, plus a right to +possession of the Corresponding Source of the work from the predecessor in +interest, if the predecessor has it or can get it with reasonable efforts. -You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. +You may not impose any further restrictions on the exercise of the rights +granted or affirmed under this License. For example, you may not impose a +license fee, royalty, or other charge for exercise of rights granted under this +License, and you may not initiate litigation (including a cross-claim or +counterclaim in a lawsuit) alleging that any patent claim is infringed by +making, using, selling, offering for sale, or importing the Program or any +portion of it. ### 11. Patents. -A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". +A "contributor" is a copyright holder who authorizes use under this License of +the Program or a work on which the Program is based. The work thus licensed is +called the contributor's "contributor version". -A contributor's "essential patent claims" are all patent claims owned -or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. +A contributor's "essential patent claims" are all patent claims owned or +controlled by the contributor, whether already acquired or hereafter acquired, +that would be infringed by some manner, permitted by this License, of making, +using, or selling its contributor version, but do not include claims that would +be infringed only as a consequence of further modification of the contributor +version. For purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of this License. -Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. +Each contributor grants you a non-exclusive, worldwide, royalty-free patent +license under the contributor's essential patent claims, to make, use, sell, +offer for sale, import and otherwise run, modify and propagate the contents of +its contributor version. -In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. +In the following three paragraphs, a "patent license" is any express agreement +or commitment, however denominated, not to enforce a patent (such as an express +permission to practice a patent or covenant not to sue for patent infringement). +To "grant" such a patent license to a party means to make such an agreement or +commitment not to enforce a patent against the party. -If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free of +charge and under the terms of this License, through a publicly available network +server or other readily accessible means, then you must either (1) cause the +Corresponding Source to be so available, or (2) arrange to deprive yourself of +the benefit of the patent license for this particular work, or (3) arrange, in a +manner consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have actual +knowledge that, but for the patent license, your conveying the covered work in a +country, or your recipient's use of the covered work in a country, would +infringe one or more identifiable patents in that country that you have reason +to believe are valid. -If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. +If, pursuant to or in connection with a single transaction or arrangement, you +convey, or propagate by procuring conveyance of, a covered work, and grant a +patent license to some of the parties receiving the covered work authorizing +them to use, propagate, modify or convey a specific copy of the covered work, +then the patent license you grant is automatically extended to all recipients of +the covered work and works based on it. -A patent license is "discriminatory" if it does not include within the -scope of its coverage, prohibits the exercise of, or is conditioned on -the non-exercise of one or more of the rights that are specifically -granted under this License. You may not convey a covered work if you -are a party to an arrangement with a third party that is in the -business of distributing software, under which you make payment to the -third party based on the extent of your activity of conveying the -work, and under which the third party grants, to any of the parties -who would receive the covered work from you, a discriminatory patent -license (a) in connection with copies of the covered work conveyed by -you (or copies made from those copies), or (b) primarily for and in -connection with specific products or compilations that contain the -covered work, unless you entered into that arrangement, or that patent -license was granted, prior to 28 March 2007. +A patent license is "discriminatory" if it does not include within the scope of +its coverage, prohibits the exercise of, or is conditioned on the non-exercise +of one or more of the rights that are specifically granted under this License. +You may not convey a covered work if you are a party to an arrangement with a +third party that is in the business of distributing software, under which you +make payment to the third party based on the extent of your activity of +conveying the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by you (or +copies made from those copies), or (b) primarily for and in connection with +specific products or compilations that contain the covered work, unless you +entered into that arrangement, or that patent license was granted, prior to 28 +March 2007. -Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available to you +under applicable patent law. ### 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under -this License and any other pertinent obligations, then as a -consequence you may not convey it at all. For example, if you agree to -terms that obligate you to collect a royalty for further conveying -from those to whom you convey the Program, the only way you could -satisfy both those terms and this License would be to refrain entirely +otherwise) that contradict the conditions of this License, they do not excuse +you from the conditions of this License. If you cannot convey a covered work so +as to satisfy simultaneously your obligations under this License and any other +pertinent obligations, then as a consequence you may not convey it at all. For +example, if you agree to terms that obligate you to collect a royalty for +further conveying from those to whom you convey the Program, the only way you +could satisfy both those terms and this License would be to refrain entirely from conveying the Program. ### 13. Use with the GNU Affero General Public License. -Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. +Notwithstanding any other provision of this License, you have permission to link +or combine any covered work with a work licensed under version 3 of the GNU +Affero General Public License into a single combined work, and to convey the +resulting work. The terms of this License will continue to apply to the part +which is the covered work, but the special requirements of the GNU Affero +General Public License, section 13, concerning interaction through a network +will apply to the combination as such. ### 14. Revised Versions of this License. -The Free Software Foundation may publish revised and/or new versions -of the GNU General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in -detail to address new problems or concerns. +The Free Software Foundation may publish revised and/or new versions of the GNU +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. -Each version is given a distinguishing version number. If the Program -specifies that a certain numbered version of the GNU General Public -License "or any later version" applies to it, you have the option of -following the terms and conditions either of that numbered version or -of any later version published by the Free Software Foundation. If the -Program does not specify a version number of the GNU General Public -License, you may choose any version ever published by the Free -Software Foundation. +Each version is given a distinguishing version number. If the Program specifies +that a certain numbered version of the GNU General Public License "or any later +version" applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published by +the Free Software Foundation. If the Program does not specify a version number +of the GNU General Public License, you may choose any version ever published by +the Free Software Foundation. -If the Program specifies that a proxy can decide which future versions -of the GNU General Public License can be used, that proxy's public -statement of acceptance of a version permanently authorizes you to -choose that version for the Program. +If the Program specifies that a proxy can decide which future versions of the +GNU General Public License can be used, that proxy's public statement of +acceptance of a version permanently authorizes you to choose that version for +the Program. -Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. +Later license versions may give you additional or different permissions. +However, no additional obligations are imposed on any author or copyright holder +as a result of your choosing to follow a later version. ### 15. Disclaimer of Warranty. -THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT -WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND -PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE -DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR -CORRECTION. +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER +PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE +QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. ### 16. Limitation of Liability. -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR -CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES -ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT -NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR -LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM -TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER -PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY +COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE +THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED +INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE +PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY +HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. ### 17. Interpretation of Sections 15 and 16. -If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. +If the disclaimer of warranty and limitation of liability provided above cannot +be given local legal effect according to their terms, reviewing courts shall +apply local law that most closely approximates an absolute waiver of all civil +liability in connection with the Program, unless a warranty or assumption of +liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS ## How to Apply These Terms to Your New Programs -If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these -terms. +If you develop a new program, and you want it to be of the greatest possible use +to the public, the best way to achieve this is to make it free software which +everyone can redistribute and change under these terms. -To do so, attach the following notices to the program. It is safest to -attach them to the start of each source file to most effectively state -the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively state the exclusion of +warranty; and each file should have at least the "copyright" line and a pointer +to where the full notice is found. Copyright (C) @@ -646,30 +584,28 @@ the exclusion of warranty; and each file should have at least the You should have received a copy of the GNU General Public License along with this program. If not, see . -Also add information on how to contact you by electronic and paper -mail. +Also add information on how to contact you by electronic and paper mail. -If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: +If the program does terminal interaction, make it output a short notice like +this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. -The hypothetical commands \`show w' and \`show c' should show the -appropriate parts of the General Public License. Of course, your -program's commands might be different; for a GUI interface, you would -use an "about box". +The hypothetical commands \`show w' and \`show c' should show the appropriate +parts of the General Public License. Of course, your program's commands might be +different; for a GUI interface, you would use an "about box". -You should also get your employer (if you work as a programmer) or -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. For more information on this, and how to apply and follow -the GNU GPL, see . +You should also get your employer (if you work as a programmer) or school, if +any, to sign a "copyright disclaimer" for the program, if necessary. For more +information on this, and how to apply and follow the GNU GPL, see +. -The GNU General Public License does not permit incorporating your -program into proprietary programs. If your program is a subroutine -library, you may consider it more useful to permit linking proprietary -applications with the library. If this is what you want to do, use the -GNU Lesser General Public License instead of this License. But first, -please read . +The GNU General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may consider +it more useful to permit linking proprietary applications with the library. If +this is what you want to do, use the GNU Lesser General Public License instead +of this License. But first, please read +. diff --git a/README.md b/README.md index 55293de..253d73c 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,33 @@ # The Biergarten App -The Biergarten App is a multi-project monorepo with a .NET backend and an active React -Router frontend in `src/Website`. The current website focuses on account flows, theme -switching, shared UI components, Storybook coverage, and integration with the API. +The Biergarten App is a multi-project monorepo with a .NET backend and an active +React Router frontend in `src/Website`. The current website focuses on account +flows, theme switching, shared UI components, Storybook coverage, and +integration with the API. ## Documentation -- [Getting Started](docs/getting-started.md) - Local setup for backend and active website -- [Architecture](docs/architecture.md) - Current backend and frontend architecture -- [Docker Guide](docs/docker.md) - Container-based backend development and testing +- [Getting Started](docs/getting-started.md) - Local setup for backend and + active website +- [Architecture](docs/architecture.md) - Current backend and frontend + architecture +- [Docker Guide](docs/docker.md) - Container-based backend development and + testing - [Testing](docs/testing.md) - Backend and frontend test commands -- [Environment Variables](docs/environment-variables.md) - Active configuration reference +- [Environment Variables](docs/environment-variables.md) - Active configuration + reference - [Token Validation](docs/token-validation.md) - JWT validation architecture -- [Legacy Website Archive](docs/archive/legacy-website-v1.md) - Archived notes for the old Next.js frontend +- [Legacy Website Archive](docs/archive/legacy-website-v1.md) - Archived notes + for the old Next.js frontend ## Diagrams - [Architecture](docs/diagrams-out/architecture.svg) - Layered architecture - [Deployment](docs/diagrams-out/deployment.svg) - Docker topology -- [Authentication Flow](docs/diagrams-out/authentication-flow.svg) - Auth sequence -- [Database Schema](docs/diagrams-out/database-schema.svg) - Entity relationships +- [Authentication Flow](docs/diagrams-out/authentication-flow.svg) - Auth + sequence +- [Database Schema](docs/diagrams-out/database-schema.svg) - Entity + relationships ## Current Status @@ -34,7 +42,8 @@ Active areas in the repository: Legacy area retained for reference: -- `src/Website-v1` contains the archived Next.js frontend and is no longer the active website +- `src/Website-v1` contains the archived Next.js frontend and is no longer the + active website ## Tech Stack @@ -43,7 +52,8 @@ Legacy area retained for reference: - **UI Documentation**: Storybook 10, Vitest browser mode, Playwright - **Testing**: xUnit, Reqnroll (BDD), FluentAssertions, Moq - **Infrastructure**: Docker, Docker Compose -- **Security**: Argon2id password hashing, JWT access/refresh/confirmation tokens +- **Security**: Argon2id password hashing, JWT access/refresh/confirmation + tokens ## Quick Start @@ -133,7 +143,8 @@ See [Testing](docs/testing.md) for the full command list. Common active variables: -- Backend: `DB_SERVER`, `DB_NAME`, `DB_USER`, `DB_PASSWORD`, `ACCESS_TOKEN_SECRET`, `REFRESH_TOKEN_SECRET`, `CONFIRMATION_TOKEN_SECRET` +- Backend: `DB_SERVER`, `DB_NAME`, `DB_USER`, `DB_PASSWORD`, + `ACCESS_TOKEN_SECRET`, `REFRESH_TOKEN_SECRET`, `CONFIRMATION_TOKEN_SECRET` - Frontend: `API_BASE_URL`, `SESSION_SECRET`, `NODE_ENV` See [Environment Variables](docs/environment-variables.md) for details. @@ -148,10 +159,13 @@ See [Environment Variables](docs/environment-variables.md) for details. ### Development Workflow -1. Start development environment: `docker compose -f docker-compose.dev.yaml up -d` +1. Start development environment: + `docker compose -f docker-compose.dev.yaml up -d` 2. Make changes to code -3. Run tests: `docker compose -f docker-compose.test.yaml up --abort-on-container-exit` -4. Rebuild if needed: `docker compose -f docker-compose.dev.yaml up -d --build api.core` +3. Run tests: + `docker compose -f docker-compose.test.yaml up --abort-on-container-exit` +4. Rebuild if needed: + `docker compose -f docker-compose.dev.yaml up -d --build api.core` ## Support diff --git a/docs/architecture.md b/docs/architecture.md index 758b0bf..6f9d774 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -4,24 +4,28 @@ This document describes the active architecture of The Biergarten App. ## High-Level Overview -The Biergarten App is a monorepo with a clear split between the backend and the active -website: +The Biergarten App is a monorepo with a clear split between the backend and the +active website: - **Backend**: .NET 10 Web API with SQL Server and a layered architecture - **Frontend**: React 19 + React Router 7 website in `src/Website` - **Architecture Style**: Layered backend plus server-rendered React frontend -The legacy Next.js frontend has been retained in `src/Website-v1` for reference only and is -documented in [archive/legacy-website-v1.md](archive/legacy-website-v1.md). +The legacy Next.js frontend has been retained in `src/Website-v1` for reference +only and is documented in +[archive/legacy-website-v1.md](archive/legacy-website-v1.md). ## Diagrams For visual representations, see: -- [architecture.svg](diagrams-out/architecture.svg) - Layered architecture diagram +- [architecture.svg](diagrams-out/architecture.svg) - Layered architecture + diagram - [deployment.svg](diagrams-out/deployment.svg) - Docker deployment diagram -- [authentication-flow.svg](diagrams-out/authentication-flow.svg) - Authentication workflow -- [database-schema.svg](diagrams-out/database-schema.svg) - Database relationships +- [authentication-flow.svg](diagrams-out/authentication-flow.svg) - + Authentication workflow +- [database-schema.svg](diagrams-out/database-schema.svg) - Database + relationships ## Backend Architecture @@ -218,7 +222,8 @@ public interface IAuthRepository ### Active Website (`src/Website`) -The current website is a React Router 7 application with server-side rendering enabled. +The current website is a React Router 7 application with server-side rendering +enabled. ```text src/Website/ @@ -244,20 +249,22 @@ src/Website/ ### Theme System -The active website uses semantic DaisyUI theme tokens backed by four Biergarten themes: +The active website uses semantic DaisyUI theme tokens backed by four Biergarten +themes: - Biergarten Lager - Biergarten Stout - Biergarten Cassis - Biergarten Weizen -All component styling should prefer semantic tokens such as `primary`, `success`, -`surface`, and `highlight` instead of hard-coded color values. +All component styling should prefer semantic tokens such as `primary`, +`success`, `surface`, and `highlight` instead of hard-coded color values. ### Legacy Frontend -The previous Next.js frontend has been archived at `src/Website-v1`. Active product and -engineering documentation should point to `src/Website`, while legacy notes live in +The previous Next.js frontend has been archived at `src/Website-v1`. Active +product and engineering documentation should point to `src/Website`, while +legacy notes live in [archive/legacy-website-v1.md](archive/legacy-website-v1.md). ## Security Architecture @@ -387,8 +394,8 @@ For details, see [Docker Guide](docker.md). ### Health Checks -**SQL Server**: Validates database connectivity **API**: Checks service health and -dependencies +**SQL Server**: Validates database connectivity **API**: Checks service health +and dependencies **Configuration**: diff --git a/docs/docker.md b/docs/docker.md index 21cb6af..a66ce68 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -1,7 +1,7 @@ # Docker Guide -This document covers Docker deployment, configuration, and troubleshooting for The -Biergarten App. +This document covers Docker deployment, configuration, and troubleshooting for +The Biergarten App. ## Overview @@ -13,7 +13,8 @@ The project uses Docker Compose to orchestrate multiple services: - .NET API - Test runners -See the [deployment diagram](diagrams/pdf/deployment.pdf) for visual representation. +See the [deployment diagram](diagrams/pdf/deployment.pdf) for visual +representation. ## Docker Compose Environments @@ -144,7 +145,11 @@ api.core / tests (start when ready) ```yaml healthcheck: - test: ['CMD-SHELL', "sqlcmd -S localhost -U sa -P '${DB_PASSWORD}' -C -Q 'SELECT 1'"] + test: + [ + "CMD-SHELL", + "sqlcmd -S localhost -U sa -P '${DB_PASSWORD}' -C -Q 'SELECT 1'", + ] interval: 10s timeout: 5s retries: 12 @@ -209,16 +214,16 @@ Each environment uses isolated bridge networks: All containers are configured via environment variables from `.env` files: ```yaml -env_file: '.env.dev' # or .env.test, .env.prod +env_file: ".env.dev" # or .env.test, .env.prod environment: - ASPNETCORE_ENVIRONMENT: 'Development' - DOTNET_RUNNING_IN_CONTAINER: 'true' - DB_SERVER: '${DB_SERVER}' - DB_NAME: '${DB_NAME}' - DB_USER: '${DB_USER}' - DB_PASSWORD: '${DB_PASSWORD}' - JWT_SECRET: '${JWT_SECRET}' + ASPNETCORE_ENVIRONMENT: "Development" + DOTNET_RUNNING_IN_CONTAINER: "true" + DB_SERVER: "${DB_SERVER}" + DB_NAME: "${DB_NAME}" + DB_USER: "${DB_USER}" + DB_PASSWORD: "${DB_PASSWORD}" + JWT_SECRET: "${JWT_SECRET}" ``` For complete list, see [Environment Variables](environment-variables.md). diff --git a/docs/environment-variables.md b/docs/environment-variables.md index b7c262f..ef7cb54 100644 --- a/docs/environment-variables.md +++ b/docs/environment-variables.md @@ -1,7 +1,7 @@ # Environment Variables -This document covers the active environment variables used by the current Biergarten -stack. +This document covers the active environment variables used by the current +Biergarten stack. ## Overview @@ -19,8 +19,8 @@ Direct environment variable access via `Environment.GetEnvironmentVariable()`. ### Frontend (`src/Website`) -The active website reads runtime values from the server environment for its auth and API -integration. +The active website reads runtime values from the server environment for its auth +and API integration. ### Docker @@ -54,14 +54,15 @@ Provide complete connection string: DB_CONNECTION_STRING="Server=localhost,1433;Database=Biergarten;User Id=sa;Password=YourStrong!Passw0rd;TrustServerCertificate=True;" ``` -**Priority**: `DB_CONNECTION_STRING` is checked first. If not found, connection string is -built from components. +**Priority**: `DB_CONNECTION_STRING` is checked first. If not found, connection +string is built from components. **Implementation**: See `DefaultSqlConnectionFactory.cs` ### JWT Authentication Secrets (Backend) -The backend uses separate secrets for different token types to enable independent key rotation and validation isolation. +The backend uses separate secrets for different token types to enable +independent key rotation and validation isolation. ```bash # Access token secret (1-hour tokens) @@ -131,8 +132,8 @@ DOTNET_RUNNING_IN_CONTAINER=true # Flag for container execution ## Frontend Variables (`src/Website`) -The active website does not use the old Next.js/Prisma environment model. Its core runtime -variables are: +The active website does not use the old Next.js/Prisma environment model. Its +core runtime variables are: ```bash API_BASE_URL=http://localhost:8080 # Base URL for the .NET API @@ -208,9 +209,10 @@ cp .env.example .env.dev ## Legacy Frontend Variables -Variables for the archived Next.js frontend (`src/Website-v1`) have been removed from this -active reference. See [archive/legacy-website-v1.md](archive/legacy-website-v1.md) if you -need the legacy Prisma, Cloudinary, Mapbox, or SparkPost notes. +Variables for the archived Next.js frontend (`src/Website-v1`) have been removed +from this active reference. See +[archive/legacy-website-v1.md](archive/legacy-website-v1.md) if you need the +legacy Prisma, Cloudinary, Mapbox, or SparkPost notes. **Docker Compose Mapping**: @@ -243,8 +245,8 @@ need the legacy Prisma, Cloudinary, Mapbox, or SparkPost notes. | `MSSQL_PID` | | | ✓ | No | SQL Server edition | | `DOTNET_RUNNING_IN_CONTAINER` | ✓ | | ✓ | No | Container flag | -\* Either `DB_CONNECTION_STRING` OR the component variables (`DB_SERVER`, `DB_NAME`, -`DB_USER`, `DB_PASSWORD`) must be provided. +\* Either `DB_CONNECTION_STRING` OR the component variables (`DB_SERVER`, +`DB_NAME`, `DB_USER`, `DB_PASSWORD`) must be provided. ## Validation @@ -258,8 +260,8 @@ Variables are validated at startup: ### Frontend Validation -The active website relies on runtime defaults for local development and the surrounding -server environment in deployed environments. +The active website relies on runtime defaults for local development and the +surrounding server environment in deployed environments. - `API_BASE_URL` defaults to `http://localhost:8080` - `SESSION_SECRET` falls back to a development-only local secret diff --git a/docs/getting-started.md b/docs/getting-started.md index 91b0672..2ed58a3 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,7 +1,7 @@ # Getting Started -This guide covers local setup for the current Biergarten stack: the .NET backend in -`src/Core` and the active React Router frontend in `src/Website`. +This guide covers local setup for the current Biergarten stack: the .NET backend +in `src/Core` and the active React Router frontend in `src/Website`. ## Prerequisites @@ -128,8 +128,9 @@ dotnet run --project API/API.Core/API.Core.csproj ## Legacy Frontend Note -The previous Next.js frontend now lives in `src/Website-v1` and is not the active website. -Legacy setup details have been moved to [docs/archive/legacy-website-v1.md](archive/legacy-website-v1.md). +The previous Next.js frontend now lives in `src/Website-v1` and is not the +active website. Legacy setup details have been moved to +[docs/archive/legacy-website-v1.md](archive/legacy-website-v1.md). ## Next Steps diff --git a/docs/testing.md b/docs/testing.md index 098fab4..ecd2e3e 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -1,6 +1,7 @@ # Testing -This document describes the testing strategy and how to run tests for The Biergarten App. +This document describes the testing strategy and how to run tests for The +Biergarten App. ## Overview @@ -9,13 +10,15 @@ The project uses a multi-layered testing approach across backend and frontend: - **API.Specs** - BDD integration tests using Reqnroll (Gherkin) - **Infrastructure.Repository.Tests** - Unit tests for data access layer - **Service.Auth.Tests** - Unit tests for authentication business logic -- **Storybook Vitest project** - Browser-based interaction tests for shared website stories -- **Storybook Playwright suite** - Browser checks against Storybook-rendered components +- **Storybook Vitest project** - Browser-based interaction tests for shared + website stories +- **Storybook Playwright suite** - Browser checks against Storybook-rendered + components ## Running Tests with Docker (Recommended) -The easiest way to run all tests is using Docker Compose, which sets up an isolated test -environment: +The easiest way to run all tests is using Docker Compose, which sets up an +isolated test environment: ```bash docker compose -f docker-compose.test.yaml up --abort-on-container-exit @@ -98,7 +101,8 @@ npm run test:storybook **Purpose**: -- Verifies shared stories such as form fields, submit buttons, navbar states, toasts, and the theme gallery +- Verifies shared stories such as form fields, submit buttons, navbar states, + toasts, and the theme gallery - Runs in browser mode via Vitest and Storybook integration ### Frontend Playwright Storybook Tests @@ -113,7 +117,8 @@ npm run test:storybook:playwright - Storybook dependencies installed - Playwright browser dependencies installed -- The command will start or reuse the Storybook server defined in `playwright.storybook.config.ts` +- The command will start or reuse the Storybook server defined in + `playwright.storybook.config.ts` ## Test Coverage @@ -278,7 +283,8 @@ Scenario: User login with valid credentials ## Continuous Integration -Tests run automatically in CI/CD pipelines using the test Docker Compose configuration: +Tests run automatically in CI/CD pipelines using the test Docker Compose +configuration: ```bash # CI/CD command @@ -292,7 +298,8 @@ Exit codes: - `0` - All tests passed - Non-zero - Test failures occurred -Frontend UI checks should also be included in CI for the active website workspace: +Frontend UI checks should also be included in CI for the active website +workspace: ```bash cd src/Website diff --git a/docs/token-validation.md b/docs/token-validation.md index ee6331d..384009f 100644 --- a/docs/token-validation.md +++ b/docs/token-validation.md @@ -2,11 +2,14 @@ ## Overview -The Core project implements comprehensive JWT token validation across three token types: +The Core project implements comprehensive JWT token validation across three +token types: - **Access Tokens**: Short-lived (1 hour) tokens for API authentication -- **Refresh Tokens**: Long-lived (21 days) tokens for obtaining new access tokens -- **Confirmation Tokens**: Short-lived (30 minutes) tokens for email confirmation +- **Refresh Tokens**: Long-lived (21 days) tokens for obtaining new access + tokens +- **Confirmation Tokens**: Short-lived (30 minutes) tokens for email + confirmation ## Components @@ -17,10 +20,13 @@ The Core project implements comprehensive JWT token validation across three toke Low-level JWT operations. **Methods:** + - `GenerateJwt()` - Creates signed JWT tokens - `ValidateJwtAsync()` - Validates token signature, expiration, and format -**Implementation:** [JwtInfrastructure.cs](Infrastructure.Jwt/JwtInfrastructure.cs) +**Implementation:** +[JwtInfrastructure.cs](Infrastructure.Jwt/JwtInfrastructure.cs) + - Uses Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler - Algorithm: HS256 (HMAC-SHA256) - Validates token lifetime, signature, and well-formedness @@ -32,16 +38,20 @@ Low-level JWT operations. High-level token validation with context (token type, user extraction). **Methods:** + - `ValidateAccessTokenAsync(string token)` - Validates access tokens - `ValidateRefreshTokenAsync(string token)` - Validates refresh tokens - `ValidateConfirmationTokenAsync(string token)` - Validates confirmation tokens **Returns:** `ValidatedToken` record containing: + - `UserId` (Guid) - `Username` (string) - `Principal` (ClaimsPrincipal) - Full JWT claims -**Implementation:** [TokenValidationService.cs](Service.Auth/TokenValidationService.cs) +**Implementation:** +[TokenValidationService.cs](Service.Auth/TokenValidationService.cs) + - Reads token secrets from environment variables - Extracts and validates claims (Sub, UniqueName) - Throws `UnauthorizedException` on validation failure @@ -51,15 +61,18 @@ High-level token validation with context (token type, user extraction). Token generation (existing service extended). **Methods:** + - `GenerateAccessToken(UserAccount)` - Creates 1-hour access token - `GenerateRefreshToken(UserAccount)` - Creates 21-day refresh token -- `GenerateConfirmationToken(UserAccount)` - Creates 30-minute confirmation token +- `GenerateConfirmationToken(UserAccount)` - Creates 30-minute confirmation + token ### Integration Points #### [ConfirmationService](Service.Auth/IConfirmationService.cs) **Flow:** + 1. Receives confirmation token from user 2. Calls `TokenValidationService.ValidateConfirmationTokenAsync()` 3. Extracts user ID from validated token @@ -69,6 +82,7 @@ Token generation (existing service extended). #### [RefreshTokenService](Service.Auth/RefreshTokenService.cs) **Flow:** + 1. Receives refresh token from user 2. Calls `TokenValidationService.ValidateRefreshTokenAsync()` 3. Retrieves user account via `AuthRepository.GetUserByIdAsync()` @@ -78,6 +92,7 @@ Token generation (existing service extended). #### [AuthController](API.Core/Controllers/AuthController.cs) **Endpoints:** + - `POST /api/auth/register` - Register new user - `POST /api/auth/login` - Authenticate user - `POST /api/auth/confirm?token=...` - Confirm email @@ -88,11 +103,13 @@ Token generation (existing service extended). ### Token Secrets Three independent secrets enable: + - **Key rotation** - Rotate each secret type independently - **Isolation** - Compromise of one secret doesn't affect others - **Different expiration** - Different token types can expire at different rates **Environment Variables:** + ```bash ACCESS_TOKEN_SECRET=... # Signs 1-hour access tokens REFRESH_TOKEN_SECRET=... # Signs 21-day refresh tokens @@ -111,6 +128,7 @@ Each token is validated for: ### Error Handling Validation failures return HTTP 401 Unauthorized: + - Invalid signature → "Invalid token" - Expired token → "Invalid token" (message doesn't reveal reason for security) - Missing claims → "Invalid token" @@ -149,16 +167,19 @@ Validation failures return HTTP 401 Unauthorized: ### Unit Tests **TokenValidationService.test.cs** + - Happy path: Valid token extraction - Error cases: Invalid, expired, malformed tokens - Missing/invalid claims scenarios **RefreshTokenService.test.cs** + - Successful refresh with valid token - Invalid/expired refresh token rejection - Non-existent user handling **ConfirmationService.test.cs** + - Successful confirmation with valid token - Token validation failures - User not found scenarios @@ -166,16 +187,19 @@ Validation failures return HTTP 401 Unauthorized: ### BDD Tests (Reqnroll) **TokenRefresh.feature** + - Successful token refresh - Invalid/expired token rejection - Missing token validation **Confirmation.feature** + - Successful email confirmation - Expired/tampered token rejection - Missing token validation **AccessTokenValidation.feature** + - Protected endpoint access token validation - Invalid/expired access token rejection - Token type mismatch (refresh used as access token) diff --git a/tooling/pipeline/ETHICS-AND-KNOWN-ISSUES.md b/tooling/pipeline/ETHICS-AND-KNOWN-ISSUES.md index f218e73..2c1686a 100644 --- a/tooling/pipeline/ETHICS-AND-KNOWN-ISSUES.md +++ b/tooling/pipeline/ETHICS-AND-KNOWN-ISSUES.md @@ -52,12 +52,12 @@ artificial intelligence is incapable of.** ## Model Bias and Language Quality -The underlying model's training biases surface within this pipeline. -Output quality tracks with how well a language is represented in the training -corpus: standard French (`fr-FR`) produces coherent text; regional variants like -`fr-CD` and `fr-CI` are noticeably weaker; low-resource languages like Welsh, -Māori, and Sicilian produce output that is syntactically plausible but often -semantically broken. +The underlying model's training biases surface within this pipeline. Output +quality tracks with how well a language is represented in the training corpus: +standard French (`fr-FR`) produces coherent text; regional variants like `fr-CD` +and `fr-CI` are noticeably weaker; low-resource languages like Welsh, Māori, and +Sicilian produce output that is syntactically plausible but often semantically +broken. This is a property of the training distribution, not something that can be mitigated through prompt design. This is a well-documented characteristic of @@ -235,7 +235,9 @@ idiomatic phrasing. ] ``` -This dataset, when fed into the pipeline will often times reason that a local variant of French is needed, but will often times just default to a standardized dialect of French, devoid of any cultural or linguistic nuance. +This dataset, when fed into the pipeline will often times reason that a local +variant of French is needed, but will often times just default to a standardized +dialect of French, devoid of any cultural or linguistic nuance. For languages such as Welsh (Wales), Māori (Aotearoa/New Zealand), or Sicilian (Sicily, Italy), the model can generate text that looks syntactically plausible @@ -260,7 +262,13 @@ Output sample: ## Footnotes -[^llm-choke]: CHOKE (Certain Hallucinations Overriding Known Evidence) is a hallucination failure mode defined by Simhi et al. (2025), in which a model that can consistently answer a question correctly produces a confident, wrong response when the prompt is trivially perturbed. Source: Trust Me, I'm Wrong: LLMs Hallucinate with Certainty Despite Knowing the Answer — Adi Simhi, Itay Itzhak, Fazl Barez, Gabriel Stanovsky, Yonatan Belinkov. +[^llm-choke]: + CHOKE (Certain Hallucinations Overriding Known Evidence) is a hallucination + failure mode defined by Simhi et al. (2025), in which a model that can + consistently answer a question correctly produces a confident, wrong + response when the prompt is trivially perturbed. Source: Trust Me, I'm + Wrong: LLMs Hallucinate with Certainty Despite Knowing the Answer — Adi + Simhi, Itay Itzhak, Fazl Barez, Gabriel Stanovsky, Yonatan Belinkov. [^llm-bias]: e.g., Blasi et al. (2022), "Systematic Inequalities in Language Technology @@ -279,8 +287,12 @@ Output sample: [creativecommons.org/licenses/by-sa/4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en). [^diacetyl-source]: - White Labs confirms that diacetyl is a yeast-derived fermentation byproduct: specifically, a compound produced during amino acid metabolism that leaks out of the yeast cell and oxidises into its characteristic buttery off-flavour. It is generally considered undesirable at any perceived level in most styles, though low levels are tolerated in some English ales and European lagers. - Source: + White Labs confirms that diacetyl is a yeast-derived fermentation byproduct: + specifically, a compound produced during amino acid metabolism that leaks + out of the yeast cell and oxidises into its characteristic buttery + off-flavour. It is generally considered undesirable at any perceived level + in most styles, though low levels are tolerated in some English ales and + European lagers. Source: [whitelabs.com — Compound Spotlight: Diacetyl](https://www.whitelabs.com/news-update-detail?id=54). [^diacetyl-rest]: diff --git a/tooling/pipeline/prompts/system.md b/tooling/pipeline/prompts/system.md index 4d77bf8..8c8d8dd 100644 --- a/tooling/pipeline/prompts/system.md +++ b/tooling/pipeline/prompts/system.md @@ -1,8 +1,13 @@ # FULL SYSTEM PROMPT -You are an expert brewery copywriter, an architectural observer, and a master of zymurgy. +You are an expert brewery copywriter, an architectural observer, and a master of +zymurgy. -Your main goal is to come up with a fake, contextually accurate name and a matching description for a craft brewery located in a specific city. You need to base this on the exact geographic and cultural info provided. You also need to seamlessly blend historical background, cultural details, and highly specialized brewing methods to create a realistic and interesting story. +Your main goal is to come up with a fake, contextually accurate name and a +matching description for a craft brewery located in a specific city. You need to +base this on the exact geographic and cultural info provided. You also need to +seamlessly blend historical background, cultural details, and highly specialized +brewing methods to create a realistic and interesting story. You will receive the inputs like this: @@ -24,17 +29,28 @@ You will receive the inputs like this: ## CRITICAL OUTPUT FORMAT (READ CAREFULLY): -ABSOLUTELY NO MARKDOWN FORMATTING. Do NOT wrap your response in json or ``` blocks. +ABSOLUTELY NO MARKDOWN FORMATTING. Do NOT wrap your response in json or ``` +blocks. -Do not add markdown, code fences, or postscript around the final JSON object. Do not say "Here is the JSON" or "Enjoy!". +Do not add markdown, code fences, or postscript around the final JSON object. Do +not say "Here is the JSON" or "Enjoy!". -The JSON must contain exactly four keys ("name_en", "description_en", "name_local", "description_local") in that order. Do not rename or add any other keys. +The JSON must contain exactly four keys ("name_en", "description_en", +"name_local", "description_local") in that order. Do not rename or add any other +keys. -ESCAPE ALL QUOTES inside all description fields using \", or use single quotes (' ') instead. This applies equally to description_en and description_local. If the local language uses non-standard quotation marks (such as guillemets or corner brackets), write them as literal Unicode characters rather than escaped HTML entities, and do not nest them inside double quotes without escaping. +ESCAPE ALL QUOTES inside all description fields using \", or use single quotes +(' ') instead. This applies equally to description_en and description_local. If +the local language uses non-standard quotation marks (such as guillemets or +corner brackets), write them as literal Unicode characters rather than escaped +HTML entities, and do not nest them inside double quotes without escaping. -DO NOT use actual line breaks (\n) inside any string. Keep all descriptions as one continuous string each. +DO NOT use actual line breaks (\n) inside any string. Keep all descriptions as +one continuous string each. -The description_en and description_local must each be between 225 and 300 words. Do not pad with repetition or summary, every sentence must earn its place. Be concise and specific. +The description_en and description_local must each be between 225 and 300 words. +Do not pad with repetition or summary, every sentence must earn its place. Be +concise and specific. Expected JSON format: @@ -51,38 +67,64 @@ Expected JSON format: ### THE HOOK: -The first sentence must be a sensory environmental hook written as a personal observation, something the owner notices or has always noticed. It should establish the local weather, smell, or soundscape of the city. Do not open with the brewery's name or a generic welcome. +The first sentence must be a sensory environmental hook written as a personal +observation, something the owner notices or has always noticed. It should +establish the local weather, smell, or soundscape of the city. Do not open with +the brewery's name or a generic welcome. ### GEOGRAPHIC & CULTURAL ANCHOR: -The story must be deeply tied to the provided geographic and cultural info. Weave in one or two specific historical or cultural details that ground the brewery in its place, enough to feel local, not so much that it reads like a history lesson. +The story must be deeply tied to the provided geographic and cultural info. +Weave in one or two specific historical or cultural details that ground the +brewery in its place, enough to feel local, not so much that it reads like a +history lesson. ### TECHNICAL BREWING DETAIL (VARY THIS!): -You must include one highly specialized technical brewing detail. To avoid sounding repetitive, make sure this varies a lot. Some examples: using local wild yeast (like spontaneous Brettanomyces), adjusting the water profile (like Burtonization), specific mashing techniques, or using local barrels for aging. Don't use basic concepts like generic mash temperatures. +You must include one highly specialized technical brewing detail. To avoid +sounding repetitive, make sure this varies a lot. Some examples: using local +wild yeast (like spontaneous Brettanomyces), adjusting the water profile (like +Burtonization), specific mashing techniques, or using local barrels for aging. +Don't use basic concepts like generic mash temperatures. ### ARCHITECTURAL DETAIL (VARY THIS!): -You must include one specific architectural or environmental detail, highlighting the building's physical wear, structure, or history. The owner should describe it with personal familiarity, something they've lived with long enough to stop noticing, then started noticing again. Avoid overused industry clichés like repurposed dairy equipment or glycol chillers. +You must include one specific architectural or environmental detail, +highlighting the building's physical wear, structure, or history. The owner +should describe it with personal familiarity, something they've lived with long +enough to stop noticing, then started noticing again. Avoid overused industry +clichés like repurposed dairy equipment or glycol chillers. ### THE INVITATION: -The last sentence must be a personal, low-key invitation from the owner, specific about place, not generic about the experience. The owner should point somewhere concrete rather than issuing a formal welcome. Avoid clichés like "come find us," "stop by anytime," "grab a stool," or "ask the bartender." +The last sentence must be a personal, low-key invitation from the owner, +specific about place, not generic about the experience. The owner should point +somewhere concrete rather than issuing a formal welcome. Avoid clichés like +"come find us," "stop by anytime," "grab a stool," or "ask the bartender." ### LOCAL LANGUAGE VERSION: name_local is a direct translation of name_en into the local language or script. -Use the supplied local language codes to choose the language or script, and do not invent a language that is not listed. +Use the supplied local language codes to choose the language or script, and do +not invent a language that is not listed. -description_local carries the same content and structure as description_en but should read as though written by an owner who assumes their reader shares the local cultural context, references that needed explaining in English can be stated plainly, and phrasing should reflect natural idiom in that language rather than translated English sentence structure. +description_local carries the same content and structure as description_en but +should read as though written by an owner who assumes their reader shares the +local cultural context, references that needed explaining in English can be +stated plainly, and phrasing should reflect natural idiom in that language +rather than translated English sentence structure. The length and anti-AI-pattern requirements apply equally to description_local. -The register of description_local should match the local variant of the language appropriate to the city, québécois French for Montréal, Belgian French for Brussels, castilian Spanish for Madrid, rioplatense Spanish for Buenos Aires, and so on. +The register of description_local should match the local variant of the language +appropriate to the city, québécois French for Montréal, Belgian French for +Brussels, castilian Spanish for Madrid, rioplatense Spanish for Buenos Aires, +and so on. ### THE BLOCKLIST (FORBIDDEN CONCEPTS): -You absolutely cannot use the following words and phrases. Make sure your final output doesn't have any of these: +You absolutely cannot use the following words and phrases. Make sure your final +output doesn't have any of these: - "hidden gem" - "passion" @@ -99,15 +141,27 @@ You absolutely cannot use the following words and phrases. Make sure your final #### FORBIDDEN WRITING PATTERNS -The following patterns are common AI writing pitfalls and must not appear in either description: +The following patterns are common AI writing pitfalls and must not appear in +either description: -- Negative parallelism constructions: "It's not X, it's Y" or "We're not about X, we're about Y" -- Inflated significance phrases: "stands as a testament," "plays a vital role," "leaves a lasting impact," "watershed moment," "deeply rooted," "rich cultural heritage," "rich cultural tapestry," "enduring legacy" -- Superficial trailing analyses: sentences ending in -ing words that add opinion without content ("ensuring consistency," "reflecting the city's spirit," "highlighting our commitment") -- Promotional travel-copy tone: "breathtaking," "must-visit," "stunning," "vibrant" -- Overused conjunctive transitions used as sentence openers: "Moreover," "Furthermore," "In addition," "In contrast" +- Negative parallelism constructions: "It's not X, it's Y" or "We're not about + X, we're about Y" +- Inflated significance phrases: "stands as a testament," "plays a vital role," + "leaves a lasting impact," "watershed moment," "deeply rooted," "rich cultural + heritage," "rich cultural tapestry," "enduring legacy" +- Superficial trailing analyses: sentences ending in -ing words that add opinion + without content ("ensuring consistency," "reflecting the city's spirit," + "highlighting our commitment") +- Promotional travel-copy tone: "breathtaking," "must-visit," "stunning," + "vibrant" +- Overused conjunctive transitions used as sentence openers: "Moreover," + "Furthermore," "In addition," "In contrast" - Rule of three: do not consistently organise ideas or examples in triplets ### VOICE & PERSPECTIVE: -The description must be written in the first person, from the perspective of the brewery's owner. Favour "we" and "our" over "I" and "my." The owner may use "I" sparingly for personal observations that only they could make, but the default register should be collective. The tone should feel lived-in and a little weathered. Do not use third-person or second-person pronouns. +The description must be written in the first person, from the perspective of the +brewery's owner. Favour "we" and "our" over "I" and "my." The owner may use "I" +sparingly for personal observations that only they could make, but the default +register should be collective. The tone should feel lived-in and a little +weathered. Do not use third-person or second-person pronouns.