diff --git a/.github/ISSUE_TEMPLATE/bug-problem-report.md b/.github/ISSUE_TEMPLATE/bug-report.md similarity index 56% rename from .github/ISSUE_TEMPLATE/bug-problem-report.md rename to .github/ISSUE_TEMPLATE/bug-report.md index 2eaaf88..62b7215 100644 --- a/.github/ISSUE_TEMPLATE/bug-problem-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,6 +1,6 @@ --- -name: Bug/problem report -about: Create a bug/issue report for any problems +name: Bug Report +about: Create a bug report for any problems while using the documentation title: "" labels: "" assignees: "" @@ -8,19 +8,17 @@ assignees: "" Make sure this issue isn't already listed here before submitting. -If you need help with Direct URL's checkout this guide: - -https://hass-agent-beta.github.io/contributing/reporting-issues/ +Before creating an issue checkout our guide here: https://hass-agent.github.io/latest/contributing/reporting-issues/ --- ## Describe the bug/problem -A clear and concise description of what the bug or problem with a section is. +A clear and concise description of what the bug or problem is. ## Where does this issue occur? -**Include Direct URL to section; Info above** +**Include Permalink to the section if applicable. Info in the guide above** ## Expected behaviour / expected information diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..f2cec47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,33 @@ +--- +name: Feature Request +about: Suggest a new feature or improvement +title: "" +labels: "" +assignees: "" +--- + +Before creating a feature request, please check if a similar request already exists. + +Before submitting, refer to our guide on reporting issues/improvements here: https://hass-agent.github.io/latest/contributing/reporting-issues/ + +--- + +## Feature Description + +A clear and concise description of the feature you are proposing. + +## Use Case + +Explain the scenario or use case where this feature would be beneficial. Include a permalink to the docs if applicable(More info in the guide above). + +## Expected Behavior + +Describe the expected behavior or outcome after the implementation of the proposed feature. + +## Additional Context + +Provide any additional context or information that might be relevant to the feature request. + +## Optional: Design or Mockups + +If you have any designs, mockups, or visual concepts related to the feature, you can attach them here. diff --git a/.github/workflows/release-beta.yml b/.github/workflows/release-beta.yml index 3cb855d..2d088c0 100644 --- a/.github/workflows/release-beta.yml +++ b/.github/workflows/release-beta.yml @@ -45,10 +45,7 @@ jobs: - name: Deploy copy of beta with incremented version number for development run: | mike deploy -p -u ${{ inputs.new_version }} beta -t beta - - name: Merge beta branch with main - run: | - git fetch --unshallow - git checkout main - git pull - git merge --no-ff beta -m "Auto-Merge beta into main" - git push + - name: Create Pull Request from beta to main + run: gh pr create --base main --head beta --title "Merge beta into main" --body "Auto-Merge beta into main" + env: + GH_TOKEN: ${{ secrets.PAT_TOKEN }} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..23e4731 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +FROM squidfunk/mkdocs-material:9.5.0 + +WORKDIR /app + +COPY . /app +RUN pip install -r requirements.txt + + +EXPOSE 8000 + +CMD ["serve", "--dev-addr=0.0.0.0:8000"] diff --git a/LICENSE b/LICENSE index f288702..8d0af59 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - 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. - - Preamble - - 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. - - 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. - - 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. - - 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. - - 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. - - TERMS AND CONDITIONS - - 0. Definitions. - - "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. - - "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. - - 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 "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 -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. - - 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 "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 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. - - 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. - - 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. - - 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. - - 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 -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. - - 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: - - 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 -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: - - 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 "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. - - 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). - - 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. - - 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. - - 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: - - 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. - - 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. - - 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). - - 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. - - 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. - - 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. - - 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. - - 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'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. - - 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, 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. - - 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 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. - - 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. - - 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. - - 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. - - 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. - - 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. - - 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. - - 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) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - 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. - - 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". - - 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 -. +MIT License + +Copyright (c) 2023-2024 HASS.Agent Team + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 84d5e7d..64c1017 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@

- - + + HASS.Agent

View the documentation - here + here


@@ -15,27 +15,22 @@ ## Overview -This repository contains all the files used to create [HASS.Agent's documentation](https://hass-agent-beta.github.io/). +This repository contains all the files used to create [HASS.Agent's documentation](https://hass-agent.io/). ### Branches -- `main` --> contains the source code +- `main` --> contains the current "latest" docs version +- `beta` --> contains the current "beta" docs version - `gh-pages` --> deployable (builded) version ## Deployed Documentation -The documentation is deployed here on github pages, you can view it [here](https://hass-agent-beta.github.io/). +The documentation is deployed here on github pages, you can view it [here](https://hass-agent.io/). ## Development / Contributing -> Pleas do **not** submit pull requests to this repo. - -If you would like to help out with development or translating of the HASS.Agent application check out our guide [here](https://hass-agent-beta.github.io/contributing/). +If you would like to help out with development or translating of the HASS.Agent application check out our guide [here](https://hass-agent.io/latest/contributing/). ### Contributing to the documentation -You can either submit github tickets with the info you want added to the documentation or make the changes yourself. You can submit a ticket for any issues, edits or info you want added to the docs. If you want to make the changes yourself continue reading. - -### Editing the docs yourself - -Checkout [this](https://hass-agent-beta.github.io/contributing/#helping-out-with-the-documentation) page for information on contributing to the documentation. +You can either submit github tickets with the info you want added to the documentation or make the changes yourself. You can submit a ticket for any issues, edits or info you want added to the docs. If you want to make the changes yourself checkout [the docs](https://hass-agent.io/latest/contributing/#helping-out-with-the-documentation). diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..9ded46b --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,9 @@ +version: "3" +services: + docs: + build: . + container_name: hass-agent-docs + ports: + - "8000:8000" + volumes: + - .:/app diff --git a/docs/assets/images/logo/logo-128.png b/docs/assets/images/logo/logo-128.png index 37e6f83..3f8fdff 100644 Binary files a/docs/assets/images/logo/logo-128.png and b/docs/assets/images/logo/logo-128.png differ diff --git a/docs/assets/images/logo/logo-256.png b/docs/assets/images/logo/logo-256.png new file mode 100644 index 0000000..2df108e Binary files /dev/null and b/docs/assets/images/logo/logo-256.png differ diff --git a/docs/assets/images/logo/logo_256.png b/docs/assets/images/logo/logo_256.png deleted file mode 100644 index 2cf450f..0000000 Binary files a/docs/assets/images/logo/logo_256.png and /dev/null differ diff --git a/docs/assets/images/screenshots/command-example.png b/docs/assets/images/screenshots/command-example.png new file mode 100644 index 0000000..ad3a0db Binary files /dev/null and b/docs/assets/images/screenshots/command-example.png differ diff --git a/docs/assets/images/screenshots/command-friendly-name.png b/docs/assets/images/screenshots/command-friendly-name.png new file mode 100644 index 0000000..3c47e77 Binary files /dev/null and b/docs/assets/images/screenshots/command-friendly-name.png differ diff --git a/docs/assets/images/screenshots/create-docs-fork.png b/docs/assets/images/screenshots/create-docs-fork.png new file mode 100644 index 0000000..f5924b3 Binary files /dev/null and b/docs/assets/images/screenshots/create-docs-fork.png differ diff --git a/docs/assets/images/screenshots/quick-action-description.png b/docs/assets/images/screenshots/quick-action-description.png new file mode 100644 index 0000000..2744dcc Binary files /dev/null and b/docs/assets/images/screenshots/quick-action-description.png differ diff --git a/docs/assets/images/screenshots/quick-action-new.png b/docs/assets/images/screenshots/quick-action-new.png new file mode 100644 index 0000000..83c4f79 Binary files /dev/null and b/docs/assets/images/screenshots/quick-action-new.png differ diff --git a/docs/assets/images/screenshots/sensor-friendly-name.png b/docs/assets/images/screenshots/sensor-friendly-name.png new file mode 100644 index 0000000..f746703 Binary files /dev/null and b/docs/assets/images/screenshots/sensor-friendly-name.png differ diff --git a/docs/assets/images/screenshots/sensor-new.png b/docs/assets/images/screenshots/sensor-new.png new file mode 100644 index 0000000..3f886f5 Binary files /dev/null and b/docs/assets/images/screenshots/sensor-new.png differ diff --git a/docs/assets/images/screenshots/text-to-speech.png b/docs/assets/images/screenshots/text-to-speech.png new file mode 100644 index 0000000..7c47512 Binary files /dev/null and b/docs/assets/images/screenshots/text-to-speech.png differ diff --git a/docs/stylesheets/extra.css b/docs/assets/stylesheets/extra.css similarity index 70% rename from docs/stylesheets/extra.css rename to docs/assets/stylesheets/extra.css index 054f4ca..21f8d35 100644 --- a/docs/stylesheets/extra.css +++ b/docs/assets/stylesheets/extra.css @@ -3,3 +3,7 @@ --md-primary-fg-color--light: #41bdf5; --md-primary-fg-color--dark: #41bdf5; } + +.md-header__button.md-logo img { + height: 2rem; +} diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..1abd714 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,4 @@ +--- +title: Changelog +template: changelog.html +--- diff --git a/docs/contributing/developer-resources/current-devs.md b/docs/contributing/developer-resources/current-devs.md new file mode 100644 index 0000000..090712c --- /dev/null +++ b/docs/contributing/developer-resources/current-devs.md @@ -0,0 +1,31 @@ +# Current Code Maintainers + +Here you can find the list of current developers and what they help contribute. You will find discord and github links if you need to contact them for help with development. + +!!! warning + + **Do not spam** + We have given you these links so you can use them correctly and to get help, they are not for you to message about some small issue that the rest of the community can help with. If you need help with their specific contributions or need to message the lead devs you can use the links in the tabs below. + +??? question "Get added to this list" + + If you actively maintain the codebase for a week or more, head over to the Discord server and ask one of the lead devs to verify you and add you to this list. + +=== "Client/App" + + **Lead Dev** + + - **[amadeo-alex](https://github.com/amadeo-alex){: target="\_blank"}:** Creator of the unofficial version of HASS.Agent + - Discord: [Amadeo](https://discord.com/users/135056992745029632){: target="\_blank"} + + **Other Contributors** + + - **[MinimumDowntime](https://github.com/MinimumDowntime){: target="\_blank"}:** Github Actions Workflows + - Discord: [Automaton](https://discord.com/users/350097059640115200){: target="\_blank"} + +=== "Documentation" + + **Lead Dev** + + - **[DrR0x-Glitch](https://github.com/drr0x){: target="\_blank"}:** Creator of this documentation + - Discord: [DrR0x](https://discord.com/users/638245963240046592){: target="\_blank"} diff --git a/docs/contributing/developer-resources/index.md b/docs/contributing/developer-resources/index.md new file mode 100644 index 0000000..c2959ea --- /dev/null +++ b/docs/contributing/developer-resources/index.md @@ -0,0 +1,7 @@ +# Extra Resources for Developers + +This section contains extra and shared resources for developers. You will find information in here that will be used across parts of HASS.Agent. + +### Versioning + +The HASS.Agent client uses a version system that is shared with the documentation, you can read more on this [here](./version-system.md). diff --git a/docs/contributing/developer-resources/version-system.md b/docs/contributing/developer-resources/version-system.md new file mode 100644 index 0000000..0b4fbf7 --- /dev/null +++ b/docs/contributing/developer-resources/version-system.md @@ -0,0 +1,103 @@ +# HASS.Agent's version system + +!!! warning + + You must read and understand this entire page if you want to be able to develop any part of HASS.Agent. It helps you to understand the versioning and how to understand different versions of HASS.Agent + +## Overview + +#### HASS.Agent is based on one version system + +All parts off HASS.Agent use semver to keep track of their versions. + +## Summary of SemVer + +This is a general summary of SemVer and how you will indicate different versions throughout development. You may be tempted to skip this if you know SemVer but don't, because how we indicate dev builds and betas is different to others. + +### Stable release versions + +All release version numbers of HASS.Agent look like this: `..` +An example of a released version number: `1.5.4` + +#### Major + +The major version number is rarely changed, if you are reading this documentation you will most likely never have to change this. But for your information it is only changed when breaking API updates are added. So version `2.*.*` client, is **not** backwards compatible with version `2.*.*`. This also means that all versions of `1.*.*` will be backwards compatible, there may be small warnings or missing features but all previous API calls and features work as intended. Basically this version number only needs to be incremented when no backwards compatability is added. This also forces the dev team to not release backwards compatible updates very often. + +???+ example + + - Version `1.4.2` of the client **does** have backwards compatibility with version `1.8.3` + - Version `2.3.2` of the lient **does not** have backwards compatibility with version `1.8.3` + +#### Minor + +The minor version number is to be incremented whenever new features are added in a backwards compatible way. More than one feature **can** be added per version number, however they all have to have backwards compatibility. + +???+ example + + - Version `1.4.1` of the client will have **less** features than `1.5.0` + - Version `1.6.0` of the client will have **more** features than `1.5.0` + + **Note that in both of these examples the versions are backwards compatible.** + +#### Patch + +The patch version number is to be incremented whenever bug fixes(patches) are released in a backwards compatible way. All bug fixes are to be released in a backwards compatible way anyway, so basically everytime a patch is released, this number will be incremented. The important thing to note about the patch version number is that **no new features** can be added. + +???+ example + + - Version `1.3.0` of the client will have more bugs than `1.3.1` of the client + - Version `1.5.6` of the client will have more patches and therefore less bugs, than `1.5.2` of the client + + **No new features are added between the versions in these examples. Only bug fixes and patches are added.** + +### Beta developmental versions + +During the development of a new version of the HASS.Agent client beta versions of the code will exist. These versions will be denoted like this: `..-beta.` You will notice the only difference is the addition of the `-beta` flag and the fourth version number `` +The first beta version of the example upcoming `1.5.3` release would look like this: `1.5.3-beta.0` + +#### Beta version + +The beta version number is to be incremented whenever a new beta version of the code is built or released for testing. + +???+ example annotate + + > The current stable version is `2.5.4` and the dev team is working on a new feature + + The beta version during the first development update should be `2.6.0-beta.0` + + Everytime a new development update is added to this feature the last number should be incremented. + + > The dev team has now finished working on this feature + + The stable version for release should be `2.6.0` + + > The dev team has found bugs and is working on a hotfix. They are in devlopment of the second hotfix right now. + + The current beta version should be `2.6.1-beta.1` (1) + + > They have now completed this hotfix + + The stable release version should be `2.6.1` + +1. We use 1 for the `` here, because hotfix 1 was .0 and hotfix 2 was .1 + +### Other info + +#### Resetting numbers + +Whenever a "parent" version number is incremented the "children" numbers must be rest to zero. + +???+ example + + - If the current version is `1.5.6` and a new backwards **compatible** feature is being added the new version will be `1.6.0` + - If the current version is `1.5.6` and a new backwards **incompatible** feature is being added the new version will be `2.0.0` + +#### Documentation + +The documentation operates on version of just `.` This will still match the client because no major documentation change will happen during a patch of the HASS.Agent client. + +The other difference between this version system and the client's version system is that beta version attributes will not exist. In the documentation if the upcoming release is going to be `1.5.0` and the current beta version is `1.5.0-beta.3` then the docs will have `1.5` with the label/attribute `beta`. + +## Relationship between the client and the integration + +Both the client and the integration are going to be using SemVer, however it will **not** be the same version. Instead when you checkout the installation for HASS.Agent it will tell you what version of the integration is required. The other thing is that most of the integration's development will be backwards compatible and not move up from version `2`. diff --git a/docs/contributing/hass-agent-documentation/adding-pages.md b/docs/contributing/hass-agent-documentation/adding-pages.md new file mode 100644 index 0000000..fd12618 --- /dev/null +++ b/docs/contributing/hass-agent-documentation/adding-pages.md @@ -0,0 +1,35 @@ +# Adding new pages + +You can add new pages anywhere in the documentation if you feel the need to. However we do recommend checking in with the other docs developers before adding a new page, to make sure it is needed. + +## Creating the page + +You start by creating a new .md with an all lowercase name, you can use `-` dashes in place of spaces. For example this file is called `adding-pages.md` This file should be located in the section you want it, for example; if you want a new page in this documentation contributing section you will create the page in the `docs/contributing/hass-agent-documentation/`. + +Now you can use a heading 1 to indicate the name of this page. Example: `# Adding new pages` + +## Adding it to the navtree + +You now need to open the `mkdocs.yml` file in the root of the documentation. At the very bottom you will see: + +```yaml +nav: + - Home: index.md +``` + +To add your page you need to find the section you have placed your file in, for example a file placed in the `docs/contributing/hass-agent-documentation` should be added under the: + +```yaml +nav: + - Helping Out: + - Developing the Documentation: +``` + +You create a new entry by indenting and adding a `- ` and then writing the name of your page that you want in the sidebar navigation, so keep it short. Then you add a `:` and follow it by the directory of the file. +???+ note + + This directory starts in the docs folder so you will just write `contributing/hass-agent-documentation`, not `docs/contributing/hass-agent-documentation`. + +## Editing and Testing the page + +You can now edit the page and fill it with content, all of the changes should show in your browser and the page should be visible in the left navigation sidebar. diff --git a/docs/contributing/hass-agent-documentation/development-lifecycle.md b/docs/contributing/hass-agent-documentation/development-lifecycle.md new file mode 100644 index 0000000..8e18a6d --- /dev/null +++ b/docs/contributing/hass-agent-documentation/development-lifecycle.md @@ -0,0 +1,97 @@ +# The development lifecycle + +## Overview + +This page contains all the information about the development lifecycle of the documentation. Start here with this diagram: + +#### This is a flowchart you can reference which has the timeline of events happening during development + +```mermaid +flowchart TB + beta-changes("Submit PR with changes") + style beta-changes fill:#3395C2 + beta-pr>Beta PR merged] + + beta-changes-->|Approve PR|beta-pr + beta-branch===beta-pr + + beta-pr --> |Deploy beta version| beta-deployment{{Beta Deployment}} + + beta-pr === start-beta-release + + start-beta-release --> |Deploy new Beta version| beta-deployment + + subgraph subg ["Release Beta"] + style subg fill:#0000, stroke:#CCCCCC, stroke-width:5px + + start-beta-release>Prepare beta for Release] --> |Deploy beta as latest| latest-deployment{{Latest Deployment}} + + + start-main-release>Prepare main for Release] ==o merge-beta + + start-beta-release ==> |Merge beta with main| merge-beta>Merge beta] + + start-main-release --> |Deploy as version number into old versions| old-versions[(Old Versions)] + end + + main-branch ==== start-main-release + + merge-beta ==> new-beta-branch>Updated Beta Branch] + merge-beta ==> new-main-branch>Updated Main Branch] + + beta-branch>Beta Branch] + main-branch>Main Branch] +``` + +The highlighted blue node is where your changes will be entered into the process. You will create a Pull Request to have your code reviewed and then merged into the specified branch. + +## Picking a branch + +At the start of each change you want to work on you will first workout which branch to use. 99% of the time you should use the `beta` branch so that your changes are included in future versions of the documentation. + +## Editing files + +### Starting development + +To start off you will run `docker-compose up` to start the docker container and live reload server. + +### Modifying and saving markdown files + +After selecting a branch you will modify any markdown files you want and save the changes. After saving, the localhost will reload and you can check your changes. For an in-depth tutorial on how to modify all files and the specific features/syntax included in this documentation check out [this](./editing-files.md) page. + +## Uploading changes + +### Commiting to your fork + +After all edits have been made you can commit the changes to your repo. You should follow these main guidelines: + +- There **is** such thing as too many commits. As much as we want you to separate each change into it's own commit try to not do 100 commits. +- Also don't do just 1 commit, if you only fix 1 file than 1 commit is fine, but if you have edited multiple files then more than 1 commit is appreciated. +- Make proper commit messages; don't just say `fixed grammar`, specify the page and what section you have fixed. + +### Creating a PR + +After you finalise your edits and have commited them all to your fork you can create a PR back to the documentation repo. Once again the same rules apply as commit messages, try to make them specific. After submitting your PR it will be reviewed and accepted by one of our admins and then it will enter the workflow found [here](#this-is-a-flowchart-you-can-reference-which-has-the-timeline-of-events-happening-during-development). + +## Done + +Your changes will now be live here on the documentation! You can check them out by navigating to the page you modified. + +### Lifecycle + +This is a diagram of the development lifecycle: + +```mermaid +flowchart LR + pick-branch(Pick a Branch) --> start-dev(Start Development) --> make-changes(Make Changes) --> errors?{Errors?} --> |Yes| make-changes + + errors? --> |No| commit(Commit changes) --> pr(Create PR) --> |PR Approved| merge([Merge PR, start again]) --> pick-branch +``` + +### Further Reading + +Now that you understand the basic workflow of editing the docs you can checkout these guides to get started on editing: + +- [Editing Pages - Markdown](./editing-files.md) +- [Adding Pages](./adding-pages.md) +- [Special Pages - Other files](./special-files.md) diff --git a/docs/contributing/hass-agent-documentation/easy-editing.md b/docs/contributing/hass-agent-documentation/easy-editing.md new file mode 100644 index 0000000..69be754 --- /dev/null +++ b/docs/contributing/hass-agent-documentation/easy-editing.md @@ -0,0 +1,3 @@ +# Easier method of editing the documentation + +You can easily edit parts of pages by clicking the edit button at the top right of any page. It will link you to github and help you fork the repo and edit the file. diff --git a/docs/contributing/hass-agent-documentation/editing-files.md b/docs/contributing/hass-agent-documentation/editing-files.md new file mode 100644 index 0000000..5e0135f --- /dev/null +++ b/docs/contributing/hass-agent-documentation/editing-files.md @@ -0,0 +1,319 @@ +# Editing the documentation files + +!!! note + + Before you read through here make sure you understand the [Development Lifecycle](./development-lifecycle.md) and have finished the [Setup Guide](./setup.md). + +## Directory Structure + +To start off with you will want to understand the directory structure of the documentation. + +### Root directory + +At the root of the project you will see a directory structure similar to this: + +```bash +├───.github +│ ├───ISSUE_TEMPLATE +│ └───workflows +├───docs +├───overrides +│ ├───home.html +│ └───main.html +├───mkdocs.yaml +└───requirements.txt +``` + +#### Important files + +- `mkdocs.yaml`: The top-level configuration of the documentation. Holds information such as the navtree and plugins used. +- `requirements.txt`: Used to hold all versions of dependencies required for the documentation. You will not need to edit this. + +#### Important directories + +- `.github`: This folder contains information for github such as the issue templates and the workflows. + +- `docs`: This folder contains all of the files used to make the pages of the documentation. This is where you will find the markdown files. + +- `overrides/`: This folder contains "Theme Overrides", which allow us to have very fine control over the documentation. + +#### Other directories + +There are some other files/folders you will find in your project directory such as `venv/`, `.gitignore` and `README.md`. These are all files that will not need to be edited so I don't explain them here. + +!!! note "Special Files" + + Most of these files/folders are talked about in more detail on the [Special Files](./special-files.md) page. + +### `docs/` Directory Structure + +The `docs/` folder is where you will be spending the majority of the time. It contains all of the `*.md` files as well as the assets used in the documentation. The basic directory structure looks like this: + +```bash +├───assets +│ └───images +│ ├───icons +│ ├───logo +│ └───screenshots +├───contributing +├───getting-started +├───layouts +├───stylesheets +└───index.md +``` + +#### Assets + +This folder contains the assets used in the documentation. This folder mainly contains images at the moment. You will find it is organised into subfolders, in this case just `images/`. When you need to reference any image you will be navigating here. + +#### Special Directories + +- `layouts/`: Contains the images and layouts used across the documentation for specific usecases. Currently it just hold data for Jinja templates that make up the social cards. + +- `stylesheets/`: Contains the extra `*.css` files used to overwrite documentation styling. Things such as the color scheme is found here. + +#### Other Directories + +The rest of the directories found here are sections of the documentation. Each one of these directories corresponds to a section. For example the `contributing/` directory corresponds to the "Helping Out" section you are in right now. + +#### `index.md` - special file + +`index.md` is a special file that you will find in every folder that holds `*.md` files. This file is the "Home" of every folder. So when it is in the root `docs/` folder it is the homepage for the entire site. Another example is the one in the `contributing/` folder that is the home of the "Helping Out" section, and so on and so forth. + +!!! note "Special Case: Homepage" + + The `index.md` file in the root `docs/` directory doesn't contain any actual markdown. This is because it is a fully custom page that is written in html and css as a theme override, there is more information about it [here](./special-files.md/#homepage). + +## Intro to Markdown + +This section will serve as a very basic intro to markdown. As well as describe the extra features included with the documentation that are not in normal markdown. + +To start off with, most of the stuff written will just be plain text, for example this section you are reading right now is just plain text. + +### Simple Formatting Options + +- Titles: `# Title` We use hashtags to indicate titles, you can go from heading 1 to 6, 1 being the largest heading and 6 being the smallest. This number corresponds to the number of hashtags. A heading 3 would look like this: `### Title`. +- Bold: `**Bold text**` We use Double Asterisks to indicate bold text. +- Code blocks: `` This is a `Code block`, specifically an inline one `` Multiline ones are also available, checkout [this](#codeblocks) section for more +- Lists: `- List item` A dash indicates a bulleted list, like this one. And for numbered you just write `1. Numbered list item` + +> Callouts like this one can be written using a `> ` at the start: `> Example callout` + +You will notice all of these require a certain character followed by a space. If you do not include a space between the special character and the text it will not showup correctly. + +### Hyperlinks + +We use the standard markdown implementation for hyper links however some extra attributes can be added. Here is a standard link with the text home and the link to the homepage: + +```md +[home](https://hass-agent.github.io/latest/) +``` + +#### Inside Links + +Inside links point to pages or sections inside of this documentation, for example I want to navigate a user to the forking section of the setup for editing the documentation: + +```md +[More info on forking the repo](./setup.md/#forking-the-repo) +``` + +[More info on forking the repo](./setup.md/#forking-the-repo) + +This link points to a local file by using a `./` followed by the name of the file. If you want to go up a directory you use `../` These can be chained together to get anywhere in the documentation. E.g `../../getting-started/index.md` + +The hashtag specifies which section of the page you want to link to, vscode should autocomplete this for you but if not you can click the P icon to the right of any heading in the docs and the url at the top will end with the correct hashtag link to use. + +!!! example + + This section we are in right now can be linked to with `#inside-links` + +#### External Links + +You can add links that point to any address however most of the time they should be opened in a new tab. Unless the link is a direct file download link you need to add this attribute to tell the browser to open the link in a new tab: `{: target="\_blank"}` + +```md title="Example link to open google in a new tab" +[google](https://google.com){: target="\_blank"} +``` + +[google](https://google.com){: target="\_blank"} + +### Newlines and document structure + +Every different "text-type" should have a newline separating it from the previous one. So there should be a new line between titles and paragraphs and also a new line between a title and a group of list items, etc. + +### Separating paragraphs + +You can separate paragraphs in two ways, here are the 2 options: +Text starting on next line. + +Gap before next text block. + +> You can create a gap between each paragraph by just creating a newline in the file. To continue the text without a gap but on the next line you add 2 spaces to the end of the previous line. + +## Codeblocks + +Codeblocks are unsurprisingly used to indicate code, they have different styling and can be copied as well as highlighted depending on the syntax. + +### Inline Codeblocks + +These are the most simple. They are just a small section of a paragraph or line. These do not have options such as a copy button or annotations. + +> Example: `Inline codeblock here` Normal text here + +You can write these inline codeblocks by adding a backtick: `` ` ``, at the start and end of the codeblock. + +### Multiline Codeblocks + +These codeblocks are slightly more complex but include features such as a copy button and line highlighting. + +#### Basic codeblock + +A basic codeblock can be written using 3 backticks: ` ``` ` at the start and end. + +````title="Example basic codeblock syntax" +``` +def add1(num): + return num += 1 +``` +```` + +**Looks like this:** + +``` +def add1(num): + return num += 1 +``` + +You will notice a copy button at the top right of each codeblock. + +#### Syntax Highlighting + +You can add syntax highlighting for almost every language. Here is the same python function with some highlighting: + +```py +def add1(num): + return num += 1 +``` + +To do this you add a language shortcode right after the backtick(s). Like this: + +```` +```py +Highlighted as python +``` +```` + +#### Line numbers, titles and highlighting lines + +##### Line Numbers + +You can add line numbers with `linenums="1"` this will make the first line 1. You can set the first line to any number; +For example, to start at 54(1): use `linenums="54"`. +{.annotate} + +1. This is just an example number, any number can be used. + +##### Highlighting Lines + +You can also highlight any of the lines using `hl_lines="2 3"`; this will highlight lines 2 and 3, if you want to use a range just add a dash: `hl_lines="3-5"` + +##### Adding Titles + +Titles can be added with `title="This is a title"` + +```py linenums="1" hl_lines="2" title="With line numbers, a title and line 2 highlighted" +def add1(num): + return num += 1 +``` + +## Annotations, Footnotes and Admonitions + +The documentation also has annotations and admonitions which are not a normal markdown feature. + +### Annotations + +#### Annotations Overview + +Annotations are small plus buttons that can be placed almost anywhere in the documentation that when clicked show more information.(1) +{.annotate} + +1. This is an example annotation + +#### Syntax + +You can add these anywhere with a number inside of 2 parentheses, example: `(1)`. And then at the end of that block you add `{.annotate}` followed by a numbered list corresponding to the annotation number. Here is an example with comments to help you understand: + +```md hl_lines="4" +Example bit of text with annotation here: (1) + +Another annotation here: (2) +{.annotate} + +1. This is the first annotation - corresponds to `(1)` +2. Another annotation - corresponds to `(2)` +``` + +!!! note + + Note the `{.annotate} after the codeblock, it is required for the list item to not be rendered and instead link to the `(1)`. + Also note the numbers used, they must matchup for the annotations to work correctly. + +> More information can be found [here](https://squidfunk.github.io/mkdocs-material/reference/annotations/){: target="\_blank"} + +### Footnotes + +Footnotes can be added anywhere in a page. They work similarly to the annotations and look like this: + +> There is a footnote at the end of this sentence.[^1] + +#### Syntax + +You indicate footnotes anywhere in a page with `[^1]` with the number working the same as the annotations. Just make sure the number corresponds between the location in the page and at the bottom. + +At the very bottom of the page you write the same identifier, so in this case `[^1]` followed by a `:` like this: + +```md hl_lines="3" +Text with footnote here: [^1] + +[^1]: This is an example footnote text +``` + +> More information can be found [here](https://squidfunk.github.io/mkdocs-material/reference/footnotes/?h=footnote){: target="\_blank"} + +### Admonitions + +Admonitions are the "notes" or "warnings" you will have seen, they are in a colored box and stand out. Here is an example: + +??? example "Example admonition" + + Admonition text + +#### Syntax + +They can be written like this: + +```md +!!! note + + This is a note admonition +``` + +Titles can be included by adding text in `""` after the admonition type: + +``` +!!! note "Note admonition example title" +``` + +#### Collapsible admonitions + +You can create either static admonitions or collapsible ones. Collapsible ones are indicated with a `???` instead of `!!!`, if you would like the collapsible one to be open by default then use `???+`. + +> More informaition including the list of admonition types can be found [here](https://squidfunk.github.io/mkdocs-material/reference/admonitions/){: target="\_blank"} + +## Diagrams + +The documentation has multiple diagrams spread across the pages that can be edited from the markdown files. All of these are based on [mermaidjs](http://mermaid.js.org/syntax/flowchart.html){: target="\_blank"}. + +The documentation basically exlusively uses flowcharts for better styling but all mermaid types are technically supported. You can find docs on the flowcharts [here](http://mermaid.js.org/syntax/flowchart.html){: target="\_blank"}, and more information about our implementation of mermaidjs [here](https://squidfunk.github.io/mkdocs-material/reference/diagrams/){: target="\_blank"}. + +[^1]: The example footnote, you can use the enter button here to return to where you were: diff --git a/docs/contributing/hass-agent-documentation/index.md b/docs/contributing/hass-agent-documentation/index.md index f9962dd..a489a60 100644 --- a/docs/contributing/hass-agent-documentation/index.md +++ b/docs/contributing/hass-agent-documentation/index.md @@ -1 +1,109 @@ # Contributing to the HASS.Agent Documentation + +!!! note "Easier Editor" + + If you do not understand the basics of VSCode or git version control then take a look at [this](./easy-editing.md) page. + +!!! warning + + **Make sure you understand the HASS.Agent client version system before continuing. You can find info on it [here](../developer-resources/version-system.md/#clientdocumentation-versioning).** + +## Overview + +The HASS.Agent docs are built on MKDocs, which is a python based tool that allows you to write documentation in simple markdown. Most of the docs is written in markdown and is therefore easily editable. However submitting these edits and testing them requires a basic understanding of git and github version control. + +### The documentation versions + +At the top of the documentation you will find a selector to the write of the title. This is a version selector that allows you to view different versions of the documentation. You will notice there are two special versions and the rest follow the format of `*.*`: + +| Version | Description | +| -------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `beta` | The current beta build of the documentation, used for trying new features and writing docs for upcoming features of HASS.Agent. | +| `latest` | The current latest release of HASS.Agent, this is also the default version. | +| `*.*` | Older versions of the docs, these are not editable. These are known as `old-versions` Example: `1.5` | + +## Github Structure + +The repo for the documentation is linked at the top right of the documentation at all times and is also available [here](https://github.com/hass-agent/hass-agent.github.io){: target="\_blank"}. Go ahead and open it in another tab to reference as you go through this section. + +### Branches Overview + +The repo contains three branches: + +| Branch | Description | +| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `main` | Contains the files used to maintain the `latest`[^1] version of the documentation. | +| `beta` | Contains the files developing the next release of the documentation, this is also the `beta`[^1] version of the documentation. | +| `gh-pages` | Contains the built files of the documentation, this repo is not to be touched, everything is written in HTML, CSS and JS. All the files are auto-generated during builds of the documentation. | + +#### Why two separate branches? + +We use two separate branches in the github as it allows us to work on new versions of the documentation while fixing issues with the current documentation. This is great for us as we can test new features online and send them to people without accidently destroying the `latest`[^1] documentation. However this does create a few guidelines that need to be followed: + +- If you want your changes to be applied in all future versions of the documentation you **MUST** make these changes in the `beta` branch. +- Any changes made to the `main` branch will be immediately applied to the `latest`[^1] version however they will **not** be included in future versions of the documentation. + +If you would like to know why these restrictions exist checkout [this](#why-are-there-restrictions) section. + +### Deploying the documentation + +After merges occur to either the `beta` or `main` branch specific github workflows will run that wil automatically build and deploy the correct version of the documentation. Therefore you **do not** need to ever do any sort of building or deploying. + +#### Releasing the `beta` version + +When it comes time to release the `beta`[^1] version of the documentation as the `latest`[^1] version, one of the admins of the github will manually trigger a workflow that will deploy and build the `beta` branch as the `latest`[^1] version and also deploy a copy for the `beta`[^1] version. After the deployment a merge will be triggered to merge the `beta` branch with the `main` branch. We will do our best to bring over changes from the `main` branch to the `beta` but we cannot guarantee, this is the reason for [this](#why-are-there-restrictions) section. + +### Why are there restrictions? + +These restrictions exist because of the way the system is built. Here is a diagram showing an example of changes made to the homepage: + +```mermaid +flowchart LR + beta>Beta Branch] + main>Main Branch] + + beta-changes(Example change to homepage) + latest-changes(Different change to homepage) + + beta-pr([Beta PR merged]) + latest-pr([Main PR merged]) + + + beta-->beta-pr + beta-changes-->|Commit changes to beta|beta-pr + main-->latest-pr + latest-changes-->|Commit changes to main|latest-pr + + beta-pr --> |Deploy beta version| beta-deployment + latest-pr --> |Deploy latest version| latest-deployment + + beta-deployment{{Beta Deployment}} + latest-deployment{{Latest Deployment}} +``` + +You will notice that now the homepage is different on each of these versions, specifically the homepage on the `main` branch has been added changes that are not included in the `beta` branch version. Now if we have a look at what happens when the beta version is released as latest: + +```mermaid +flowchart LR + beta>Beta Branch] + main>Main Branch] + + beta-deployment{{Beta Deployment}} + latest-deployment{{Latest Deployment}} + + beta --> |Deploy to latest| latest-deployment + beta --> |Deploy copy for next beta version| beta-deployment + + merge([Merge beta into main]) + + beta --> |Overwrite main with beta| merge + main --> |Changes overwritten by beta| merge + + main --> |Deploy main as it's version number| gh-pages[(Old Versions)] +``` + +When we release the `beta`[^1] version, we copy the `latest`[^1] version into the `old-versions` by changing it's name to it's version number. Then the `beta`[^1] version is deployed to `latest`[^1] and a copy is created for developing the next version. Finally the `beta` branch is merged with the `main` branch. This means that any changes added into the `main` branch will be overwritten by the `beta` branch. + +Now that you understand how the system works you can see why changes added to the `main` branch are not included in future versions of the documentation. + +[^1]: This corresponds to the label in the documentation version selector. diff --git a/docs/contributing/hass-agent-documentation/setup.md b/docs/contributing/hass-agent-documentation/setup.md new file mode 100644 index 0000000..69580bf --- /dev/null +++ b/docs/contributing/hass-agent-documentation/setup.md @@ -0,0 +1,63 @@ +# Setting up a local environment to develop the documentation + +!!! note + + You should understand the github structure before attempting this, more info can be found [here](./index.md/#github-structure). + +## Forking the repo + +To start off you will need to create your own fork of the documentation repo to track your changes. To do this go ahead and navigate to [this](https://github.com/hass-agent/hass-agent.github.io){: target="\_blank"} repo. You will need to create a fork of this repo, a tutorial for this can be found [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo){: target="\_blank"}. + +### Forking all branches + +!!! warning + + Make sure you do this step correctly or you will have problems later on. + +After clicking fork you will be presented with this screen. You can customise the repo name and description however you **must** make sure to **de-select** "Copy the `main` branch only". You need both the `main` and `beta` branches to contribute. + +![Screenshot of creating a fork github page](../../assets/images/screenshots/create-docs-fork.png) + +### Disabling github actions + +You will want to disable github actions so that nothing goes wrong. You can do that in the settings menu like this: + +Settings --> Actions / General --> Disable actions --> save + +### Deleting `gh-pages` branch + +You wil not need the `gh-pages` branch so you can delete it like this. + +Select the current branch --> View all branches --> Select the delete icon next to the `gh-pages` branch + +## Setting up the local branches + +Now you will want to navigate to a directory on your pc for HASS.Agent, I will be using `HASS.Agent` + +Now go ahead and create at least one new folder named `hass-agent-docs-beta`. + +### Clone the branches to each folder + +Open a command prompt in the `HASS.agent` directory and clone the `beta` branch of your forked repo into the `hass-agent-docs-beta` folder. You can use the `-b beta` flag for this. + +## Setting up local environment + +???+ warning "Docker Required" + + Docker is required to contribute to the documentation, you can get it [here](https://hub.docker.com){: target="\_blank"}. You will also need the docker engine to be running whenever you want to edit the documentation. + +### Setup Docker + +To setup the local docker environment all you need to do is run the following command: + +```bash +docker-compose up +``` + +This will build and setup the local docker and activate the live reload editing page. You can view this page at [localhost:8000](http://localhost:8000){: target="\_blank"}. + +As long as this page successfully shows the documentation you can continue on to the development lifecycle and editing pages. + +???+ info "Hotfixes on the main branch" + + If you want to put hotfixes onto the main branch you can repeat the steps from [here](#setting-up-the-local-branches). diff --git a/docs/contributing/hass-agent-documentation/special-files.md b/docs/contributing/hass-agent-documentation/special-files.md new file mode 100644 index 0000000..e5e12c6 --- /dev/null +++ b/docs/contributing/hass-agent-documentation/special-files.md @@ -0,0 +1,41 @@ +# Special Files + +## Theme Overrides + +Theme overrides are files that override the theme and style of the documentation. The homepage is the biggest one. + +### Homepage + +You will notice the homepage is so different compared to the rest of the documentation, this is because it is a theme override that is overriding the markdown page. + +#### The markdown file + +The base index.md file that is the homepage just contains the following code: + +```md +--- +title: Home +template: home.html +--- +``` + +This sets the title to be Home and tells the theme that I want to use the theme override `home.html` as the "template". This renders the file `home.html` as the homepage. + +#### The `home.html` file + +The `home.html` file is in the `overrides/` folder and contains a few keywords to tell the docs to render the header tabs and footer. After that the whole file is just ` + +{% endblock %} diff --git a/overrides/home.html b/overrides/home.html new file mode 100644 index 0000000..f195007 --- /dev/null +++ b/overrides/home.html @@ -0,0 +1,284 @@ + + +{% extends "main.html" %} {% block tabs %} {{ super() }} + + + +
+
+
+
+

Welcome to HASS.Agent

+

A windows Home Assistant client(Companion App) that provides powerful features for automating your windows system.

+ Get Started +
+ +
+
+
+ +
+
+
+ + Sensors Icon +

Sensors

+

Send all sorts of telemetry data from windows to home assistant.

+

Examples:

+
    +
  • Current CPU Load
    • +
  • Are you using webcam
    • +
  • Are you logged in
    • +
+ +
+
+ + Commands Icon +

Commands

+

Control your pc by interacting with entities in home assistant.

+

Examples:

+
    +
  • Open App
    • +
  • Shutdown/logoff/restart
    • +
  • Run powershell command
    • +
+ +
+
+ + Notifications Icon +

Notifications

+

Send dynamic windows notifications with images and actions from home assistant.

+

Examples:

+
    +
  • Send from automations
    • +
  • Attach images
    • +
  • Add actions
    • +
+ +
+
+ + Quick Actions Icon +

Quick Actions

+

Add any home assistant entity to your taskbar for quick access.

+

Examples:

+
    +
  • Toggle lights
    • +
  • Run scripts
    • +
  • Start Vacuum
    • +
+ +
+
+
+ +{% endblock %} + +{% block content %}{% endblock %} diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 0000000..c45990c --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,43 @@ + +{% extends "base.html" %} + + +{% block outdated %} You're not viewing the latest version. + + Click here to go to latest. + +{% endblock %} + + +{% block extrahead %} {{ super() }} + +{% endblock %} + + +{% block content %} {{ super() }} + +{% endblock %} + + +{% block announce %} + + + + + We need help! If you have experience in C# or Python we would love to have you help out. Click here for more. + + +{% endblock %} {% block released_widget %} + + + + + +{% endblock %} diff --git a/requirements.txt b/requirements.txt index 8fa8d9a..718851d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ -mkdocs-material[imaging]==9.4.8 -mike==2.0.0 \ No newline at end of file +mkdocs-material[imaging] +mike \ No newline at end of file diff --git a/theme_override_home/home.html b/theme_override_home/home.html deleted file mode 100644 index 7cf5e0b..0000000 --- a/theme_override_home/home.html +++ /dev/null @@ -1,210 +0,0 @@ - - -{% extends "main.html" %} {% block tabs %} {{ super() }} - - - -
-
-
-
-

Welcome to HASS.Agent

-

A windows Home Assistant client(Companion App) that provides powerful features for automating your windows system.

- Get Started -
- -
-
-
- -
-
-
- Sensors Icon -

Sensors

-

Send all sorts of telemetry data from windows to home assistant.

-

Examples:

-
    -
  • Current CPU Load
    • -
  • Are you using webcam
    • -
  • Are you logged in
    • -
-
-
- Commands Icon -

Commands

-

Control your pc by interacting with entities in home assiatant.

-

Examples:

-
    -
  • Open App
    • -
  • Shutdown/logoff/restart
    • -
  • Run powershell command
    • -
-
-
- Notifications Icon -

Notifications

-

Send dynamic windows notifications with images and actions from home assistant.

-

Examples:

-
    -
  • Send from automations
    • -
  • Attach images
    • -
  • Add actions
    • -
-
-
- Quick Actions Icon -

Quick Actions

-

Add any home assistant entity to your taskbar for quick access.

-

Examples:

-
    -
  • Toggle lights
    • -
  • Run scripts
    • -
  • Start Vacuum
    • -
-
-
-
- -{% endblock %} - -{% block content %}{% endblock %} diff --git a/theme_override_home/main.html b/theme_override_home/main.html deleted file mode 100644 index 2fea99b..0000000 --- a/theme_override_home/main.html +++ /dev/null @@ -1,33 +0,0 @@ - -{% extends "base.html" %} - - -{% block outdated %} You're not viewing the latest version. - - Click here to go to latest. - -{% endblock %} - - -{% block announce %} - - - - - We need help! If you have experience in C# or Python we would love to have you help out. Click here for more. - - -{% endblock %}