Documentation is out of sync with go-storage repo

[xxchan]

• doc homepage & go-storage README docs: Reorganize README for better understanding go-storage#613 (comment)
• operations
  • behavior specification
    • Tracking issue for GSP-134: Write Behavior Consistency go-storage#624
    • Tracking issue for GSP-654: Unify List Behavior go-storage#657
  • docs for Direr is missing #157

[xxchan]

How can we maintain docs effectively and easily? Where is the source of truth?

[Xuanwo]

Where is the source of truth?

I think go-storage definitions should be the source of truth.

[Xuanwo]

ping @abyss-w, do you have an interest to fix this issue?

[Xuanwo]

Where is the source of truth?

I think go-storage definitions should be the source of truth.

@xxchan, Do you think we need to implement a tool (or something) to sync from definitions to docs?

[xxchan]

Do you think we need to implement a tool (or something) to sync from definitions to docs?

I think if we want to put more information (e.g., more readable explanations, examples) in the doc, it will be hard to sync.

If the docs are simply synced without more information, they are hardly helpful.