TagStudioDev · CyanVoxel · Sep 7, 2024 · Sep 6, 2024 · Sep 6, 2024 · Sep 6, 2024
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -8,7 +8,7 @@ body:
       value: |
         *Please add an appropriate title for this issue.*
 
-        Before reporting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
+        Before reporting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/docs/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
         Validate that you are using an up-to-date version[^1], your issue might already be fixed!
         Questions, guidance, and usage goes in [discussions](https://github.com/TagStudioDev/TagStudio/discussions). Invalid issues will be closed.
 
@@ -20,7 +20,7 @@ body:
       options:
         - label: I am using an up-to-date version.
           required: true
-        - label: I have read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md).
+        - label: I have read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/docs/index.md).
           required: true
         - label: I have searched existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
           required: true

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -8,7 +8,7 @@ body:
       value: |
         *Please add an appropriate title for this feature request.*
 
-        Before suggesting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
+        Before suggesting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/docs/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
         Validate that you are using an up-to-date version[^1], your feature might already be implemented!
         Questions, guidance, and usage goes in [discussions](https://github.com/TagStudioDev/TagStudio/discussions). Invalid issues will be closed.
 
@@ -20,7 +20,7 @@ body:
       options:
         - label: I am using an up-to-date version.
           required: true
-        - label: I have read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md).
+        - label: I have read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/docs/index.md).
           required: true
         - label: I have searched existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
           required: true

diff --git a/.github/workflows/publish_docs.yaml b/.github/workflows/publish_docs.yaml
@@ -0,0 +1,33 @@
+name: Publish Docs 
+
+on:
+  push:
+    branches:
+      - main 
+
+permissions:
+  contents: write
+
+concurrency: 
+  group: publish-docs
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+                  mkdocs-material-
+      - run: pip install mkdocs-material mkdocs-material[imaging]
+      - run: mkdocs gh-deploy --force
+
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,13 +6,13 @@ Thank you so much for showing interest in contributing to TagStudio! Here are a
 
 ## Getting Started
 
-- Check the [Planned Features](https://github.com/TagStudioDev/TagStudio/blob/main/doc/updates/planned_features.md) page, [FAQ](/README.md/#faq), as well as the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls).
+- Check the [Planned Features](https://github.com/TagStudioDev/TagStudio/blob/main/docs/updates/planned_features.md) page, [FAQ](/README.md/#faq), as well as the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls).
 - If you'd like to add a feature that isn't on the roadmap or doesn't have an open issue, **PLEASE create a feature request** issue for it discussing your intentions so any feedback or important information can be given by the team first.
   - We don't want you wasting time developing a feature or making a change that can't/won't be added for any reason ranging from pre-existing refactors to design philosophy differences.
 
 ### Contribution Checklist
 
-- I've read the [Planned Features](https://github.com/TagStudioDev/TagStudio/blob/main/doc/updates/planned_features.md) page
+- I've read the [Planned Features](https://github.com/TagStudioDev/TagStudio/blob/main/docs/updates/planned_features.md) page
 - I've read the [FAQ](/README.md/#faq), including the "[Features I Likely Won't Add/Pull](/README.md/#features-i-likely-wont-addpull)" section
 - I've checked the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls)
 - **I've created a new issue for my feature _before_ starting work on it**, or have at least notified others in the relevant existing issue(s) of my intention to work on it

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # TagStudio (Alpha): A User-Focused Document Management System
 
 <p align="center">
-  <img width="60%" src="github_header.png">
+  <img width="60%" src="docs/assets/github_header.png">
 </p>
 
 > [!CAUTION]
@@ -11,7 +11,7 @@
 TagStudio is a photo & file organization application with an underlying system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure.
 
 <figure align="center">
-  <img width="80%" src="screenshot.jpg" alt="TagStudio Screenshot" align="center">
+  <img width="80%" src="docs/assets/screenshot.jpg" alt="TagStudio Screenshot" align="center">
 
   <figcaption><i>TagStudio Alpha v9.1.0 running on Windows 10.</i></figcaption>
 </figure>
@@ -53,7 +53,7 @@ TagStudio is a photo & file organization application with an underlying system t
 - Special search conditions for entries that are: `untagged`/`no tags` and `empty`/`no fields`.
 
 > [!NOTE]
-> For more information on the project itself, please see the [FAQ](#faq) section as well as the [documentation](/doc/index.md).
+> For more information on the project itself, please see the [FAQ](#faq) section as well as the [documentation](/docs/index.md).
 
 ## Contributing
 
@@ -178,7 +178,7 @@ As of writing (Alpha v9.3.0) the project is in a useable state, however it lacks
 ### What Features Are You Planning on Adding?
 
 > [!IMPORTANT]
-> See the [Planned Features](/doc/updates/planned_features.md) documentation for the latest feature lists. The lists here are currently being migrated over there with individual pages for larger features.
+> See the [Planned Features](/docs/updates/planned_features.md) documentation for the latest feature lists. The lists here are currently being migrated over there with individual pages for larger features.
 
 Of the several features I have planned for the project, these are broken up into “priority” features and “future” features. Priority features were originally intended for the first public release, however are currently absent from the Alpha v9.x.x builds.
 

diff --git a/doc/index.md b/doc/index.md
diff --git a/doc/library/library.md b/doc/library/library.md
diff --git a/doc/library/tag_categories.md b/doc/library/tag_categories.md
diff --git a/doc/library/tag_overrides.md b/doc/library/tag_overrides.md
diff --git a/doc/updates/planned_features.md b/doc/updates/planned_features.md
diff --git a/doc/utilities/macro.md b/doc/utilities/macro.md
diff --git a/doc/assets/db_schema.png → docs/assets/db_schema.png b/doc/assets/db_schema.png → docs/assets/db_schema.png
diff --git a/github_header.png → docs/assets/github_header.png b/github_header.png → docs/assets/github_header.png
diff --git a/docs/assets/icon.ico b/docs/assets/icon.ico
diff --git a/docs/assets/icon.png b/docs/assets/icon.png
diff --git a/screenshot.jpg → docs/assets/screenshot.jpg b/screenshot.jpg → docs/assets/screenshot.jpg
diff --git a/doc/assets/tag_override_ex-1.png → docs/assets/tag_override_ex-1.png b/doc/assets/tag_override_ex-1.png → docs/assets/tag_override_ex-1.png
diff --git a/doc/assets/tag_override_ex-2.png → docs/assets/tag_override_ex-2.png b/doc/assets/tag_override_ex-2.png → docs/assets/tag_override_ex-2.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,50 @@
+---
+title: Home
+---
+
+# Welcome to the TagStudio Documentation!
+
+!!! warning
+	This documentation is still a work in progress, and is intended to aide with deconstructing and understanding of the core mechanics of TagStudio and how it operates.
+
+![TagStudio Alpha](assets/github_header.png)
+
+
+TagStudio is a photo & file organization application with an underlying system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure.
+
+<figure markdown="span">
+  ![TagStudio screenshot](assets/screenshot.jpg)
+  <figcaption>TagStudio Alpha v9.1.0 running on Windows 10</figcaption>
+</figure>
+
+## Goals
+
+- To achieve a portable, privacy-oriented, open, extensible, and feature-rich system of organizing and rediscovering files.
+- To provide powerful methods for organization, notably the concept of tag composition, or “taggable tags”.
+- To create an implementation of such a system that is resilient against a user’s actions outside the program (modifying, moving, or renaming files) while also not burdening the user with mandatory sidecar files or otherwise requiring them to change their existing file structures and workflows.
+- To support a wide range of users spanning across different platforms, multi-user setups, and those with large (several terabyte) libraries.
+- To make the darn thing look like nice, too. It’s 2024, not 1994.
+
+## Priorities
+
+1. **The concept.** Even if TagStudio as a project or application fails, I’d hope that the idea lives on in a superior project. The [goals](#goals) outlined above don’t reference TagStudio once - _TagStudio_ is what references the _goals._
+2. **The system.** Frontends and implementations can vary, as they should. The core underlying metadata management system is what should be interoperable between different frontends, programs, and operating systems. A standard implementation for this should settle as development continues. This opens up the doors for improved and varied clients, integration with third-party applications, and more.
+3. **The application.** If nothing else, TagStudio the application serves as the first (and so far only) implementation for this system of metadata management. This has the responsibility of doing the idea justice and showing just what’s possible when it comes to user file management.
+4. (The name.) I think it’s fine for an app or client, but it doesn’t really make sense for a system or standard. I suppose this will evolve with time.
+
+## Current Features
+
+- Create libraries/vaults centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
+- Add metadata to your library entries, including:
+	- Name, Author, Artist (Single-Line Text Fields)
+	- Description, Notes (Multiline Text Fields)
+	- Tags, Meta Tags, Content Tags (Tag Boxes)
+- Create rich tags composed of a name, a list of aliases, and a list of “subtags” - being tags in which these tags inherit values from.
+- Search for entries based on tags, ~~metadata~~ (TBA), or filenames/filetypes (using `filename: <query>`)
+- Special search conditions for entries that are: `untagged`/`no tags` and `empty`/`no fields`.
+
+## Important Updates
+
+### [Database Migration](updates/db_migration.md)
+
+The "Database Migration", "DB Migration", or "SQLite Migration" is an upcoming update to TagStudio which will replace the current JSON [library](library/index.md) with a SQL-based one, and will additionally include some fundamental changes to how some features such as [tags](library/tag.md) will work.
diff --git a/docs/install.md b/docs/install.md
@@ -0,0 +1,18 @@
+# Installation
+
+To download TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagStudio/releases) section of the GitHub repository and download the latest release for your system under the "Assets" section. TagStudio is available for **Windows**, **macOS** _(Apple Silicon & Intel)_, and **Linux**. Windows and Linux builds are also available in portable versions if you want a more self-contained executable to move around.
+
+For video thumbnails and playback, you'll also need [FFmpeg](https://ffmpeg.org/download.html) installed on your system. 
+
+!!! info "For macOS Users"
+    On macOS, you may be met with a message saying _""TagStudio" can't be opened because Apple cannot check it for malicious software."_ If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says _""TagStudio" was blocked from use because it is not from an identified developer."_ Click the "Open Anyway" button to allow TagStudio to run. You should only have to do this once after downloading the application.
+
+## Optional Arguments
+
+Optional arguments to pass to the program:
+
+`--open <path>` / `-o <path>`
+: Path to a TagStudio Library folder to open on start.
+
+`--config-file <path>` / `-c <path>`
+: Path to the TagStudio config file to load.