Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

📖 Write a better documentation #87

Open
henomis opened this issue Jun 15, 2023 · 3 comments
Open

📖 Write a better documentation #87

henomis opened this issue Jun 15, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@henomis
Copy link
Owner

henomis commented Jun 15, 2023

LinGoose needs a better technical documentation.
The actual documentation can be found here https://lingoose.io/docs/

There are a lot of examples in examples/ directory that can be used as a code base for writing documentation.

@henomis henomis added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Jun 15, 2023
@tmheath
Copy link

tmheath commented Jan 16, 2024

I've been considering playing around with this for weeks now, the semester is about to start (imminently).
Would you prefer work done onto godoc or a pdf manual kind of reference? By this I mean what's visible at
the current docsite/pkg.go, or add a downloadable manual.

Honestly first time reading through the issues, I've been scared away a little by the sparse documentation, I feel
like writing a manual would be a good way to teach myself (probably slowly considering everything else going
on), and I enjoy writing anyway.

@Arundas666
Copy link

I saw that there’s a need to improve the technical documentation for LinGoose, using the examples in the examples/ directory as a code base. I’m interested in helping out with this.

Is this task still open, or is anyone already working on it? Just want to make sure before I dive in.

LinGoose needs a better technical documentation. The actual documentation can be found here https://lingoose.io/docs/

There are a lot of examples in examples/ directory that can be used as a code base for writing documentation.

@henomis
Copy link
Owner Author

henomis commented Sep 7, 2024

Hey, sorry for the delay. Lingoose has a github action to publish the /doc folder as official documentation. You could work on a PR refactoring the contents of the /doc website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants