Update README.md and add release_notes.rst

README.md

@@ -25,9 +25,12 @@ way of handling the configuration and initialization.
 
 <details>
 <summary><strong>Download custom-built executables</strong></summary>
+<br>
 
-Additionally, custom GitHub sources can be configured by specifying the environment variables, `GIT_OWNER` and `GIT_REPO`,
-provided that the executables are uploaded to releases as assets, and follows the naming convention below.
+Additionally, custom source _(to download binaries)_ can be configured by specifying the environment variables,
+`GIT_OWNER` and `GIT_REPO`<br>
+For this custom source feature to work, the executable should be uploaded to releases as assets,
+and follow the naming convention below.
 
 > **asset naming convention:** `${operating system}-{architecture}-filebrowser-{extension}`<br>
 > **example:** `darwin-amd64-filebrowser.tar.gz`
@@ -63,8 +66,8 @@ User profile's permissions are automatically set based on the `admin` flag.
 
 Refer [samples] directory for sample `.env` files. For nested configuration settings, refer the [runbook]
 
-> :warning:&nbsp;&nbsp;Any configuration changes made in the UI will be lost, unless backed up manually.<br>
-Changes should always go through the `.env` files.
+> Any configuration changes made in the UI will be lost, unless backed up manually.<br>
+> Changes should always go through the `.env` files.
 
 **[OR]**
 
@@ -81,7 +84,22 @@ if __name__ == '__main__':
     file_browser.start()
 ```
 
-> :bulb:&nbsp;&nbsp;Object level instantiation might be complex for configuration settings. So it is better to use `.env` files instead.
+> Object level instantiation might be complex for configuration settings. So it is better to use `.env` files instead.
+
+## Coding Standards
+Docstring format: [`Google`][google-docs] <br>
+Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
+
+## [Release Notes][release-notes]
+**Requirement**
+```shell
+pip install gitverse
+```
+
+**Usage**
+```shell
+gitverse-release reverse -f release_notes.rst -t 'Release Notes'
+```
 
 ## Linting
 `pre-commit` will ensure linting, and generate runbook
@@ -130,3 +148,7 @@ Licensed under the [MIT License][license]
 [gha_none_shall_pass_badge]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/markdown.yml/badge.svg
 [gha_cleanup_workflows]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/cleanup.yml
 [gha_cleanup_workflows_badge]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/cleanup.yml/badge.svg
+[release-notes]: https://github.com/thevickypedia/pyfilebrowser/blob/main/release_notes.rst
+[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
+[pep8]: https://www.python.org/dev/peps/pep-0008/
+[isort]: https://pycqa.github.io/isort/

docs/README.html

@@ -60,8 +60,11 @@ <h1>PyFileBrowser<a class="headerlink" href="#pyfilebrowser" title="Permalink to
 way of handling the configuration and initialization.</p>
 <p><a class="reference external" href="https://github.com/thevickypedia/pyfilebrowser"><code class="docutils literal notranslate"><span class="pre">pyfilebrowser</span></code></a> automatically downloads the system specific executable during startup.</p>
 <details>
-<summary><strong>Download custom-built executables</strong></summary><p>Additionally, custom GitHub sources can be configured by specifying the environment variables, <code class="docutils literal notranslate"><span class="pre">GIT_OWNER</span></code> and <code class="docutils literal notranslate"><span class="pre">GIT_REPO</span></code>,
-provided that the executables are uploaded to releases as assets, and follows the naming convention below.</p>
+<summary><strong>Download custom-built executables</strong></summary>
+<br><p>Additionally, custom source <em>(to download binaries)</em> can be configured by specifying the environment variables,
+<code class="docutils literal notranslate"><span class="pre">GIT_OWNER</span></code> and <code class="docutils literal notranslate"><span class="pre">GIT_REPO</span></code><br>
+For this custom source feature to work, the executable should be uploaded to releases as assets,
+and follow the naming convention below.</p>
 <blockquote>
 <div><p><strong>asset naming convention:</strong> <code class="docutils literal notranslate"><span class="pre">${operating</span> <span class="pre">system}-{architecture}-filebrowser-{extension}</span></code><br>
 <strong>example:</strong> <code class="docutils literal notranslate"><span class="pre">darwin-amd64-filebrowser.tar.gz</span></code></p>
@@ -95,7 +98,7 @@ <h3><code class="docutils literal notranslate"><span class="pre">.env</span></co
 User profile’s permissions are automatically set based on the <code class="docutils literal notranslate"><span class="pre">admin</span></code> flag.</p>
 <p>Refer <a class="reference external" href="https://github.com/thevickypedia/pyfilebrowser/tree/main/samples">samples</a> directory for sample <code class="docutils literal notranslate"><span class="pre">.env</span></code> files. For nested configuration settings, refer the <a class="reference external" href="https://thevickypedia.github.io/pyfilebrowser/">runbook</a></p>
 <blockquote>
-<div><p>:warning:  Any configuration changes made in the UI will be lost, unless backed up manually.<br>
+<div><p>Any configuration changes made in the UI will be lost, unless backed up manually.<br>
 Changes should always go through the <code class="docutils literal notranslate"><span class="pre">.env</span></code> files.</p>
 </div></blockquote>
 <p><strong>[OR]</strong></p>
@@ -112,10 +115,26 @@ <h3><code class="docutils literal notranslate"><span class="pre">.env</span></co
 </pre></div>
 </div>
 <blockquote>
-<div><p>:bulb:  Object level instantiation might be complex for configuration settings. So it is better to use <code class="docutils literal notranslate"><span class="pre">.env</span></code> files instead.</p>
+<div><p>Object level instantiation might be complex for configuration settings. So it is better to use <code class="docutils literal notranslate"><span class="pre">.env</span></code> files instead.</p>
 </div></blockquote>
 </section>
 </section>
+<section id="coding-standards">
+<h2>Coding Standards<a class="headerlink" href="#coding-standards" title="Permalink to this heading">¶</a></h2>
+<p>Docstring format: <a class="reference external" href="https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings"><code class="docutils literal notranslate"><span class="pre">Google</span></code></a> <br>
+Styling conventions: <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/"><code class="docutils literal notranslate"><span class="pre">PEP</span> <span class="pre">8</span></code></a> and <a class="reference external" href="https://pycqa.github.io/isort/"><code class="docutils literal notranslate"><span class="pre">isort</span></code></a></p>
+</section>
+<section id="release-notes">
+<h2><a class="reference external" href="https://github.com/thevickypedia/pyfilebrowser/blob/main/release_notes.rst">Release Notes</a><a class="headerlink" href="#release-notes" title="Permalink to this heading">¶</a></h2>
+<p><strong>Requirement</strong></p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>gitverse
+</pre></div>
+</div>
+<p><strong>Usage</strong></p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>gitverse-release<span class="w"> </span>reverse<span class="w"> </span>-f<span class="w"> </span>release_notes.rst<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;Release Notes&#39;</span>
+</pre></div>
+</div>
+</section>
 <section id="linting">
 <h2>Linting<a class="headerlink" href="#linting" title="Permalink to this heading">¶</a></h2>
 <p><code class="docutils literal notranslate"><span class="pre">pre-commit</span></code> will ensure linting, and generate runbook</p>
@@ -161,6 +180,8 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#env-files"><code class="docutils literal notranslate"><span class="pre">.env</span></code> files</a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#coding-standards">Coding Standards</a></li>
+<li><a class="reference internal" href="#release-notes">Release Notes</a></li>
 <li><a class="reference internal" href="#linting">Linting</a></li>
 <li><a class="reference internal" href="#pypi-package">Pypi Package</a></li>
 <li><a class="reference internal" href="#runbook">Runbook</a></li>

docs/README.md

@@ -25,9 +25,12 @@ way of handling the configuration and initialization.
 
 <details>
 <summary><strong>Download custom-built executables</strong></summary>
+<br>
 
-Additionally, custom GitHub sources can be configured by specifying the environment variables, `GIT_OWNER` and `GIT_REPO`,
-provided that the executables are uploaded to releases as assets, and follows the naming convention below.
+Additionally, custom source _(to download binaries)_ can be configured by specifying the environment variables,
+`GIT_OWNER` and `GIT_REPO`<br>
+For this custom source feature to work, the executable should be uploaded to releases as assets,
+and follow the naming convention below.
 
 > **asset naming convention:** `${operating system}-{architecture}-filebrowser-{extension}`<br>
 > **example:** `darwin-amd64-filebrowser.tar.gz`
@@ -63,8 +66,8 @@ User profile's permissions are automatically set based on the `admin` flag.
 
 Refer [samples] directory for sample `.env` files. For nested configuration settings, refer the [runbook]
 
-> :warning:&nbsp;&nbsp;Any configuration changes made in the UI will be lost, unless backed up manually.<br>
-Changes should always go through the `.env` files.
+> Any configuration changes made in the UI will be lost, unless backed up manually.<br>
+> Changes should always go through the `.env` files.
 
 **[OR]**
 
@@ -81,7 +84,22 @@ if __name__ == '__main__':
     file_browser.start()
 ```
 
-> :bulb:&nbsp;&nbsp;Object level instantiation might be complex for configuration settings. So it is better to use `.env` files instead.
+> Object level instantiation might be complex for configuration settings. So it is better to use `.env` files instead.
+
+## Coding Standards
+Docstring format: [`Google`][google-docs] <br>
+Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
+
+## [Release Notes][release-notes]
+**Requirement**
+```shell
+pip install gitverse
+```
+
+**Usage**
+```shell
+gitverse-release reverse -f release_notes.rst -t 'Release Notes'
+```
 
 ## Linting
 `pre-commit` will ensure linting, and generate runbook
@@ -130,3 +148,7 @@ Licensed under the [MIT License][license]
 [gha_none_shall_pass_badge]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/markdown.yml/badge.svg
 [gha_cleanup_workflows]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/cleanup.yml
 [gha_cleanup_workflows_badge]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/cleanup.yml/badge.svg
+[release-notes]: https://github.com/thevickypedia/pyfilebrowser/blob/main/release_notes.rst
+[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
+[pep8]: https://www.python.org/dev/peps/pep-0008/
+[isort]: https://pycqa.github.io/isort/

docs/_sources/README.md.txt

@@ -25,9 +25,12 @@ way of handling the configuration and initialization.
 
 <details>
 <summary><strong>Download custom-built executables</strong></summary>
+<br>
 
-Additionally, custom GitHub sources can be configured by specifying the environment variables, `GIT_OWNER` and `GIT_REPO`,
-provided that the executables are uploaded to releases as assets, and follows the naming convention below.
+Additionally, custom source _(to download binaries)_ can be configured by specifying the environment variables,
+`GIT_OWNER` and `GIT_REPO`<br>
+For this custom source feature to work, the executable should be uploaded to releases as assets,
+and follow the naming convention below.
 
 > **asset naming convention:** `${operating system}-{architecture}-filebrowser-{extension}`<br>
 > **example:** `darwin-amd64-filebrowser.tar.gz`
@@ -63,8 +66,8 @@ User profile's permissions are automatically set based on the `admin` flag.
 
 Refer [samples] directory for sample `.env` files. For nested configuration settings, refer the [runbook]
 
-> :warning:&nbsp;&nbsp;Any configuration changes made in the UI will be lost, unless backed up manually.<br>
-Changes should always go through the `.env` files.
+> Any configuration changes made in the UI will be lost, unless backed up manually.<br>
+> Changes should always go through the `.env` files.
 
 **[OR]**
 
@@ -81,7 +84,22 @@ if __name__ == '__main__':
     file_browser.start()
 ```
 
-> :bulb:&nbsp;&nbsp;Object level instantiation might be complex for configuration settings. So it is better to use `.env` files instead.
+> Object level instantiation might be complex for configuration settings. So it is better to use `.env` files instead.
+
+## Coding Standards
+Docstring format: [`Google`][google-docs] <br>
+Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
+
+## [Release Notes][release-notes]
+**Requirement**
+```shell
+pip install gitverse
+```
+
+**Usage**
+```shell
+gitverse-release reverse -f release_notes.rst -t 'Release Notes'
+```
 
 ## Linting
 `pre-commit` will ensure linting, and generate runbook
@@ -130,3 +148,7 @@ Licensed under the [MIT License][license]
 [gha_none_shall_pass_badge]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/markdown.yml/badge.svg
 [gha_cleanup_workflows]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/cleanup.yml
 [gha_cleanup_workflows_badge]: https://github.com/thevickypedia/pyfilebrowser/actions/workflows/cleanup.yml/badge.svg
+[release-notes]: https://github.com/thevickypedia/pyfilebrowser/blob/main/release_notes.rst
+[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
+[pep8]: https://www.python.org/dev/peps/pep-0008/
+[isort]: https://pycqa.github.io/isort/

docs/index.html

@@ -50,6 +50,8 @@ <h1>Welcome to PyFileBrowser’s documentation!<a class="headerlink" href="#welc
 <li class="toctree-l1"><a class="reference internal" href="README.html">PyFileBrowser</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="README.html#kick-off">Kick Off</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#environment-variables">Environment Variables</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#coding-standards">Coding Standards</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#release-notes">Release Notes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#linting">Linting</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#pypi-package">Pypi Package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#runbook">Runbook</a></li>