docs: refactor docs to use VitePress#1132
Conversation
Shinigami92
added
c: docs
I think we could use either the default Postgres Logo, or a modified version of it if you can provide such.
I would like to try an orange-brown text color.
For the start we should use local search, algolia could be enabled later in a separate PR.
Your way is MUCH better!!! 😍
We could do e.g. write one box for up-down migration/CLI, one for typescript/programmatic support and one for ... 🤔 I don't know |
Co-authored-by: Shinigami <[email protected]>
Co-authored-by: Shinigami <[email protected]>
Co-authored-by: Shinigami <[email protected]>
Co-authored-by: Shinigami <[email protected]>
Co-authored-by: Shinigami <[email protected]>
Co-authored-by: Shinigami <[email protected]>
This reverts commit 3153082.
|
#913 can be closed |
|
I will do a review tomorrow ❤️ |
|
I had a first look and this is SO MUCH STRAIGHT UP BETTER 🤩 I see there is still much todo for some more to-table conversions I also made some minor changes in terms of preferred style in |
|
I invited you to the repo with granted "write" access, so you can (if you want to) help maintaining the documentation further in the future for inside the repo |
|
ok thx, the migration to vitepress is almost complete, just need to refactor some migration pages to tables, you can merge to avoid conflicts and I'll be updating the migrations until they're all more readable |
Yeah I will do so 👍 You got an invite to the repo, so if you like, you can then remove your fork, re-clone from origin (salsita/node-pg-migrate) and then do PRs from there. This improves co-working from my side if needed. |
|
"deploy from actions" activated |
The documentation currently shows that JSON config options should be given in camelCase. However, this is incorrect - [readJson uses the same keys as the CLI argument values](https://github.com/salsita/node-pg-migrate/blob/main/bin/node-pg-migrate.ts#L325). So for example `"migrationsDir": "migrations"` will never be applied, it should instead be `"migrations-dir": "migrations"`. It looks like this has always been the case - the old documentation mentions using the CLI argument names but this was replaced with a JSON example when the docs were rewritten in salsita#1132. I have also added an example showing the support for using different config sections and the `-config-value` flag, which is not currently documented AFAICS.
The documentation currently shows that JSON config options should be given in camelCase. However, this is incorrect - [readJson uses the same keys as the CLI argument values](https://github.com/salsita/node-pg-migrate/blob/main/bin/node-pg-migrate.ts#L325). So for example `"migrationsDir": "migrations"` will never be applied, it should instead be `"migrations-dir": "migrations"`. It looks like this has always been the case - the old documentation mentions using the CLI argument names but this was replaced with a JSON example when the docs were rewritten in salsita#1132. I have also added an example showing the support for using different config sections and the `-config-value` flag, which is not currently documented AFAICS.
2 participants
This is a work in progress for the VP docs. Most of it is complete, but we need to make some decisions before I proceed.
Additionally, before merging, please remember to update the repository settings to deploy from actions rather than the branch.
demo: https://brenoepics.github.io/node-pg-migrate/