Skip to content

Commit

Permalink
✨ Various lil improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
gwennlbh committed Apr 15, 2024
1 parent d30e1be commit ecf807d
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 4 deletions.
9 changes: 9 additions & 0 deletions db/adding-easily.md
Original file line number Diff line number Diff line change
@@ -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 <your work's folder>
```

![](/db/demo-add.gif)
2 changes: 1 addition & 1 deletion db/client-libraries.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Client libraries (WIP)
# Client libraries <Badge type=warning text=beta />
12 changes: 9 additions & 3 deletions db/json-schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) <Badge type=warning text=beta /> for your language.

:::

## Getting the schemas

Expand Down Expand Up @@ -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)
3 changes: 3 additions & 0 deletions work-in-progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Work in progress

This page is still a WIP. Please check back later 🙏

0 comments on commit ecf807d

Please sign in to comment.