Skip to content

Commit

Permalink
docs: update design-goals
Browse files Browse the repository at this point in the history
  • Loading branch information
jgeluk committed Dec 10, 2024
1 parent ceaadec commit 7581762
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/design-goals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ professional documentation from it either as a document or a static website.
Primary focus is to document ontologies and knowledge graphs but ultimately
to document "knowledge" in the broadest sense of the word.

- First milestone: Replace the current code that generates the DPROD webpage (<https://ekgf.github.io/dprod/>)

> [!NOTE]
>
> An additional angle that will be explored is how to use the tool to generate
Expand Down Expand Up @@ -64,7 +66,7 @@ to document "knowledge" in the broadest sense of the word.
- [ ] Most of the logic of the program will be published as a library, so that
it can be reused in other projects.

# Configurability
## Configurability

- [ ] The program should be configurable through configuration files.
- [ ] The program should be configurable through environment variables.
Expand All @@ -79,3 +81,10 @@ to document "knowledge" in the broadest sense of the word.
they need custom logic.
- [ ] People can understand what is the output of the program and how to
use it.
- [ ] Editors should be able to run GraphArch on their own machine and see the
updated documentation straight away, ideally as a preview option in their
favorite editor (Microsoft Visual Studio Code for instance).
- [ ] Easily download and install GraphArch on Windows, MacOS and Linux.
- [ ] Generate the various types of output in seconds.
- [ ] VS Code preview.
- [ ] IntelliJ preview.

0 comments on commit 7581762

Please sign in to comment.