docsify (#499)

docsify
timgit · Sep 27, 2024 · 8974856 · 8974856
1 parent 5aeb999
commit 8974856
Show file tree

Hide file tree

Showing 23 changed files with 1,024 additions and 1,247 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ pg-boss relies on [SKIP LOCKED](https://www.2ndquadrant.com/en/blog/what-is-sele
 This will likely cater the most to teams already familiar with the simplicity of relational database semantics and operations (SQL, querying, and backups). It will be especially useful to those already relying on PostgreSQL that want to limit how many systems are required to monitor and support in their architecture.
 
 
-## Summary
+## Summary <!-- {docsify-ignore-all} -->
 * Exactly-once job delivery
 * Create jobs within your existing database transaction
 * Backpressure-compatible polling workers
@@ -67,7 +67,7 @@ yarn add pg-boss
 ```
 
 ## Documentation
-* [Docs](docs/readme.md)
+* [Docs](https://timgit.github.io/pg-boss/)
 
 ## Contributing
 To setup a development environment for this library:

diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Gemfile b/docs/Gemfile
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
diff --git a/docs/index.md → docs/README.md b/docs/index.md → docs/README.md
@@ -1,5 +1,3 @@
-# pg-boss Docs
-
 Queueing jobs in Postgres from Node.js like a boss.
 
 [![npm version](https://badge.fury.io/js/pg-boss.svg)](https://badge.fury.io/js/pg-boss)
@@ -42,7 +40,7 @@ pg-boss relies on [SKIP LOCKED](https://www.2ndquadrant.com/en/blog/what-is-sele
 This will likely cater the most to teams already familiar with the simplicity of relational database semantics and operations (SQL, querying, and backups). It will be especially useful to those already relying on PostgreSQL that want to limit how many systems are required to monitor and support in their architecture.
 
 
-## Summary
+## Summary <!-- {docsify-ignore-all} -->
 * Exactly-once job delivery
 * Create jobs within your existing database transaction
 * Backpressure-compatible polling workers
@@ -69,7 +67,7 @@ yarn add pg-boss
 ```
 
 ## Documentation
-* [Docs](docs/readme.md)
+* [Docs](https://timgit.github.io/pg-boss/)
 
 ## Contributing
 To setup a development environment for this library:

diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,14 @@
+* [Home](/)
+* [Introduction](introduction.md)
+* [Install](install.md)
+* API
+* * [Constructor](./api/constructor.md)
+* * [Events](./api/events.md)
+* * [Operations](./api/ops.md)
+* * [Queues](./api/queues.md)
+* * [Jobs](./api/jobs.md)
+* * [Scheduling](./api/scheduling.md)
+* * [PubSub](./api/pubsub.md)
+* * [Workers](./api/workers.md)
+* * [Utils](./api/utils.md)
+* [SQL](sql.md)