From ecf807d5046a44c0caeaea62f14fec29653c7ec4 Mon Sep 17 00:00:00 2001 From: Ewen Le Bihan Date: Mon, 15 Apr 2024 14:04:32 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Various=20lil=20improvements?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- db/adding-easily.md | 9 +++++++++ db/client-libraries.md | 2 +- db/json-schemas.md | 12 +++++++++--- work-in-progress.md | 3 +++ 4 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 db/adding-easily.md create mode 100644 work-in-progress.md diff --git a/db/adding-easily.md b/db/adding-easily.md new file mode 100644 index 0000000..9e5befd --- /dev/null +++ b/db/adding-easily.md @@ -0,0 +1,9 @@ +# Adding new portfolio entries easily + +With the ortfo/db CLI, there's a simple and convinient way to create a new `description.md` file interactively: + +``` +ortfodb -c /path/to/ortfodb.yaml add +``` + +![](/db/demo-add.gif) diff --git a/db/client-libraries.md b/db/client-libraries.md index f2a24f1..9d4c905 100644 --- a/db/client-libraries.md +++ b/db/client-libraries.md @@ -1 +1 @@ -# Client libraries (WIP) +# Client libraries diff --git a/db/json-schemas.md b/db/json-schemas.md index 2069ff3..acc5028 100644 --- a/db/json-schemas.md +++ b/db/json-schemas.md @@ -2,7 +2,13 @@ ortfo/db exports [JSON Schemas](https://json-schema.org/) for the different data files it uses. -These schemas serve as both validation when running the program, and as a way to provide a nice [auto-complete experience in your editor](#ide-integrations), provided that it supports JSON schemas. +These schemas serve as both validation when running the program, and as a way to provide a nice [auto-complete experience in your editor](#using-it-in-your-editor), provided that it supports JSON schemas. + +::: tip Client libraries + +Want type definitions in your code? Check out the [client libraries](/db/client-libraries.md) for your language. + +::: ## Getting the schemas @@ -83,7 +89,7 @@ VSCode Neovim : [coc-yaml](https://github.com/neoclide/coc-yaml), a [CoC](https://github.com/neoclide/coc.nvim) plugin -: Any plugin, such as [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) should also do the trick +: Any LSP client plugin, such as [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) should also do the trick _Other editors_ -: Please [contribute to the docs](https://github.com/ortfo/website/edit/main/db/json-schemas.md) +: Please contribute to the docs (see "Edit this page" just below) diff --git a/work-in-progress.md b/work-in-progress.md new file mode 100644 index 0000000..ed03398 --- /dev/null +++ b/work-in-progress.md @@ -0,0 +1,3 @@ +# Work in progress + +This page is still a WIP. Please check back later 🙏