New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Improve documentation structure #4

Open

mkroetzsch opened this issue Sep 17, 2024 · 0 comments

Member

mkroetzsch commented Sep 17, 2024 •

edited

Loading

What is currently called "Guides" should be split into several parts.

There should be an initial introductory chapter that explains what Nemo is and what it can do. Suggested pages:

Introducing Nemo (initial, high-level introduction)
Ways of using Nemo (overview of client and API options)
Rule language (to the extent that it is a first, high-level overview)
Nemo research (main citation for Nemo, complete list of publications on Nemo with links to ICCL and PDF, maybe later: list of publications that use Nemo)

Next should be a chapter "Installation and usage" possibly with the following pages:

Nemo in the browser
Installation
Command line
Rust API
Python API

mmarx added this to nemo

github-project-automation bot moved this to Todo in nemo

# for free to join this conversation on GitHub. Already have an account? # to comment