Xuanwo opened a new issue, #4738:
URL: https://github.com/apache/opendal/issues/4738
QAQ, opendal doesn't smell good at the moment.
Our codebase is full of outdated comments, typos, and incorrect examples. A
number of recently added crates lack proper documentation. The internal
implementation leaves much to be desired. We've hastily released numerous
versions, each featuring significant breaking changes and extensive
refactoring. It's time for us to pause and refine our details.
I plan to postpone all breaking changes for the next two or three releases.
During these patch versions, we can improve OpenDAL's appearance and prepare
for our upcoming journey.
I called it **QAQ Time**. Hoping the opendal community will like it.
---
I will list the tasks I aim to complete during QAQ Time. Feel free to
suggest new ones or choose any that interest you.
## Tasks
### Website
- [ ] The homepage should display additional components such as Java
binding, Python binding, and object_store.
- [ ] Docs should be reorganized with `languages`, `methods` and
`integrations`.
- [ ] Add docs for `oli`
- [ ] Add docs for `ofs`
- [ ] Add guide for all components? (I'm not sure)
- [ ] Homepage should have a link to our mailing list
### API Docs
- [ ] Re-visit all public API docs for opendal. @xuanwo
- [ ] All integration should have good README.
- [ ] All integration should have their our API docs page.
- [ ] All integration should have a basic example.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
