QAQ Time: Let's take a break and polish details of OpenDAL

[Xuanwo]

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.

What's meaning of QAQ?

I don't know, just feel QAQ while reading code.

---

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

• Move to Improve OpenDAL Website #4840

Docs

• docs: Polish README and links to docs #4741
• docs: Enhance maintainability of the service section #4742
• docs: Polish opendal rust core README #4745
• Re-visit all public API docs for opendal. @Xuanwo
• ci: Build docs for all integrations #4811
• docs: Add README and rustdoc for fuse3_opendal #4813
• All integration should have good README.
• All integration should have their API docs page.
• All integration should have a basic example.
• object_store: Generate dev docs at o.a.o #4750
• docs: Refactor rust core examples #4757
• docs(integration/unftp-sbe): Polish docs for unftp-sbe #4838
• docs(bin): Polish README for all bin #4839

Quality

• Remove the need of size in RangeWrite #4478
• refactor(object_store): Polish implementation details of object_store #4749
• refactor(dav-server): Polish dav-server integration details #4751

Typos

Yes, we all make typos, but I've made quite a few. Feel free to submit batches of typos! Including documentation improvements is even better.

[BeautyyuYanli]

And the compatibility matrix of each backend x each trait?

[Xuanwo]

And the compatibility matrix of each backend x each trait?

Can you provide more details? Are you referring to the supported features of every service?

[BeautyyuYanli]

yes. e.g.
fs: read ✓, write ✓, ...
s3: read ✓, write ✓, ...
...

[Xuanwo]

Website is a bit complex, let's move to seperate issue to track.

[Xuanwo]

All issues have been closed, let's move.