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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Docs!! #276

Open
amandesai01 opened this issue Jun 9, 2023 · 4 comments
Open

[FEATURE] Docs!! #276

amandesai01 opened this issue Jun 9, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation in-work Issue in work

Comments

@amandesai01
Copy link

Describe the feature you'd like
As I can see Flowise has gained a lot of popularity (which it deserves!) and contributors may want to start contributing. Docs become a necessary part in that process. So may be we can start writing a system level doc describing core entities and assets which makes it easy for developers to get started?

I would be more than happy to start this task. We can write JSDoc within code and export it to a documentation static site.
@HenryHengZJ
Copy link
Contributor

love the idea. I recently started writing some docs - https://github.com/FlowiseAI/FlowiseDocs
but I'm up to migrate the docs repo to main repo instead of standalone one. Similar to langchainjs

@amandesai01
Copy link
Author

Why not JS Doc? In code documentation is more handy and easy to maintain (When it comes to developer documentation).
Usage documentation can stay different. What say?

@HenryHengZJ
Copy link
Contributor

is jsdoc more suitable for API/SDK libraries?
Flowise doens't have much of API docs, and lots of the nodes integration requires screenshots (visual images/vids)
but feel free give it a try and we can see how it looks

@amandesai01
Copy link
Author

Yes I see that it doesn't contain much things to document in the first place. So, maybe this can be done later.

@HenryHengZJ HenryHengZJ added the documentation Improvements or additions to documentation label Jun 10, 2023
@HenryHengZJ HenryHengZJ added the in-work Issue in work label Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation in-work Issue in work
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@HenryHengZJ @amandesai01