diff --git a/docs/conf.py b/docs/conf.py index 78d4ecbc..d3386b12 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,7 +17,7 @@ # -- Project information ----------------------------------------------------- project = importlib.metadata.metadata("app")["Name"] -copyright = "2023, Litestar Organization" +copyright = "2024, Nectar Labs UG" author = "Cody Fincher" release = importlib.metadata.version("app") @@ -78,38 +78,27 @@ html_theme = "litestar_sphinx_theme" html_static_path = ["_static"] html_show_sourcelink = True -html_title = "Litestar Fullstack Docs" +html_title = "Chapter Docs" html_context = { - "github_user": "litestar-org", - "github_repo": "litestar-fullstack", + "github_user": "chapter-gtm", + "github_repo": "chapter", "github_version": "main", "doc_path": "docs", } html_theme_options = { "use_page_nav": False, "use_edit_page_button": True, - "github_repo_name": "litestar-fullstack", + "github_repo_name": "chapter", "logo": { - "link": "https://docs.fullstack.litestar.dev", + "link": "https://chapter.show", }, "extra_navbar_items": { "Documentation": "index", - "Community": { - "Contributing": { - "description": "Learn how to contribute to Litestar Fullstack", - "link": "contribution-guide", - "icon": "contributing", - }, - "Code of Conduct": { - "description": "Review the etiquette for interacting with the Litestar community", - "link": "https://github.com/litestar-org/.github/blob/main/CODE_OF_CONDUCT.md", - "icon": "coc", - }, - }, + "Community": {}, "About": { - "Litestar Organization": { - "description": "About the Litestar organization", - "link": "https://litestar.dev/about/organization.html", + "Chapter Organization": { + "description": "About the Chapter organization", + "link": "https://chapter.show/", "icon": "org", }, }, diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..350d17c4 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,35 @@ +================== +Chapter +================== + +The Chapter repository contains the a gtm app purpose-built for developer tools. + +.. seealso:: It is built on the `Litestar `_, `NextJS `_, + :doc:`SAQ `, `TailwindCSS `_ and uses 3rd party APIs for scrtaping and data enrichment. + +Installation +------------ + +To get started, check out :doc:`the installation guide `. + +Usage +----- + +To see how to use Chapter, check out :doc:`the usage guide `. + +Reference +--------- + +.. toctree:: + :titlesonly: + :caption: Documentation + :hidden: + + usage/index + +.. toctree:: + :titlesonly: + :caption: Development + :hidden: + + changelog diff --git a/docs/usage/index.rst b/docs/usage/index.rst new file mode 100644 index 00000000..d560930b --- /dev/null +++ b/docs/usage/index.rst @@ -0,0 +1,8 @@ +===== +Usage +===== + +.. toctree:: + :titlesonly: + + installation diff --git a/docs/usage/installation.rst b/docs/usage/installation.rst new file mode 100644 index 00000000..3d4a15e7 --- /dev/null +++ b/docs/usage/installation.rst @@ -0,0 +1,54 @@ +=============== +Getting Started +=============== + +The following is a guide to help you get this repository running. + +Setup +----- + +Most of the development-related tasks are included in the ``Makefile`` (See: :doc:`development`). +To install an environment, with all development packages run: + +.. code-block:: bash + + make install + +This command does the following: + +- Install ``pdm`` if it is not available in the path. +- Create a virtual environment with all dependencies configured +- Build assets to be hosted by production asset server + +Edit ``.env`` configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +There is a sample ``.env`` file located in the root of the repository. + +.. code-block:: bash + + cp .env.example .env + +.. tip:: ``SECRET_KEY``, ``DATABASE_URI``, and ``REDIS_URL`` are the most important config settings. + Be sure to set this properly. + +You can generate a ``SECRET_KEY`` by running: + +.. code-block:: bash + + ❯ openssl rand -base64 32 + + +U9UcN0meCsxkShMINkqZ7pcwpEpOC9AwOArZI6mYDU= + +Deploy Database Migrations +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can run most of the database commands with the integrated CLI tool. + +To deploy migration to the database, execute: + +.. code-block:: bash + + ❯ app database upgrade + 2023-06-16T16:55:17.048183Z [info ] Context impl PostgresqlImpl. + 2023-06-16T16:55:17.048251Z [info ] Will assume transactional DDL.