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

Documentation: Add documentation for different use cases and examples #11

Open
junwen-k opened this issue Jul 11, 2023 · 4 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@junwen-k
Copy link
Contributor

A good open source library cannot go without a good documentation!

Suggest to add in documentation for different use cases and examples.
A good starting point could be based on the existing features:

  1. Text
  2. Image
  3. Table
  4. Shape
  5. Canvas
  6. Group

Maybe it can also be linked back to Microsoft OpenXML's documentation for easier references.

Easier way to get started is by directly writing into the repository's README file but it could get cluttered real quick.

Perhaps having a Nextra documentation site would be helpful.
https://nextra.site/docs/docs-theme/start

@fumiama fumiama added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jul 12, 2023
@fumiama
Copy link
Owner

fumiama commented Jul 12, 2023

That's a good idea and we can use github wiki as the extra documentation site. I'll be going on it as soon as I'm free. Anyone who is interested in this project can also help us to improve the documentation by PR or opening issues.

@lordofscripts
Copy link

I agree that documentation is required, otherwise what's the use of it?

@dcharles525
Copy link
Contributor

dcharles525 commented Oct 24, 2024

I want to take this on, as I have largely documented a lot of the functions in my own project. @fumiama Any particular format you're looking for? I was going to start with a Markdown file with documentation and short examples. Then add it to the wiki.

@fumiama
Copy link
Owner

fumiama commented Oct 24, 2024

I want to take this on, as I have largely documented a lot of the functions in my own project. @fumiama Any particular format you're looking for? I was going to start with a Markdown file with documentation and short examples. Then add it to the wiki.

Thanks so much for your effort. Maybe we can start from adding the comments embedded in .go files. It supports some simple markdown grammars and will show the help of a certain function or variable in IDE when the mouse hovers.

As these are just some simple descriptions, for the sdvanced usage, we can open a wiki page or create some md files in doc folder. Of course some example codes are acceptable. It can be put in example folder.

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 enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants