README.md

TODO

GPT dialog

• Allow use Enter key to send a question
• Handle all errors. E.g., missing API key causes qa API to be unresponsive
• Make all hrefs clickable, i.e., convert https:// texts to links
• Return sign in redirect to active GPT modal window
• Show links to chapters with answer
• Allow sequential questions

Engine

• Secure API endpoint /buildPrompt by user session
• Secure API endpoint /qa by user session

How to compile on a local station

In case you want to generate the static pages locally (could be useful for large changes) follow these steps:

1. Clone the CESNET/du-docs repo git clone https://github.com/CESNET/du-docs.git.
2. Enter the directory cd du-docs.
3. (Optional) Checkout to specific branch git checkout branch_to_test.
4. Run the build (change the fumadocs version number if needed; version 16.11.1 was installed on July 15, 2016):

docker run -it --rm -p 3000:3000 --name du-docs-test -e STARTPAGE=/en/docs/introduction/introduction -v ./public:/opt/fumadocs/public -v ./content/docs:/opt/fumadocs/content/docs cerit.io/docs/fuma:v16.11.1

5. Open another terminal and change to du-docs cd du-docs. Copy local files in app and components directories over the container directories:

for dir in app components; do docker cp $dir du-docs-test:/opt/fumadocs; done

6. Documentation will be available at http://localhost:3000/en/docs/introduction/introduction; it is automatically rebuilt on source change.