aclai-lab / aclai-lab/SoleReasoners.jl

Improved documentation (examples, exported APIs, playbooks, etc.)

Abierto
#11 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation enhancement
Lenguaje dominante
Julia
Estrellas
4
Forks
0
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Hi everyone,

The documentation for the current repo could benefit from more explicit guidance on how to use the APIs. In general, the repo is solid, but it is hard for "outsiders" to understand its full capabilities, which hinders its adaptability, accessibility, and usability.

Here are some examples:
- In the getting started documentation, there is $alpha$ vs $\alpha$.
- The README.md should include examples on how to instantiate Tableaux, SAT solvers, etc. Ideally, people should understand the repo's full capabilities (e.g., different solvers, formulas, and semantics).
- What exactly is exported?
- How should one use this repo?
- What are the known limitations?
- Are there playbooks/playgrounds for users?
- Etc.

These are just a few examples. Some of them are general observations that could be applied to other repos as well within the `Sole.jl` ecosystem.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.