aclai-lab / aclai-lab/SoleReasoners.jl

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

Đang mở
#11 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation enhancement
Ngôn ngữ chính
Julia
Star
4
Fork
0
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
julia
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
54/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.