aclai-lab / aclai-lab/SoleReasoners.jl

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

Ouverte
#11 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation enhancement
Langage dominant
Julia
Étoiles
4
Forks
0
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Start with README.md and the getting-started documentation, since both are explicitly called out. Locate where API usage, exported APIs, solver examples, limitations, and playbook/playground guidance are currently documented and add the missing content there. No tests or code entry points are mentioned, so done looks like a documentation pass where a newcomer can understand capabilities and usage directly from README/getting-started sections.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
julia
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
54/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.