TypeCellOS / TypeCellOS/BlockNote

docs: File block documentation

Open
#871 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug:P3
Dominant language
TypeScript
Stars
10.2k
Forks
772
Avg merge
3d 11h
Merged PRs (30d)
17

Description

Documentation for file blocks is still outdated in the docs:

  • References image blocks only
  • No instructions on how to extend file blocks
  • Missing info like how you can drap & drop external files too after implementing uploadFile

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the current file-block documentation and the uploadFile API references first. Update the documentation to cover file blocks rather than only image blocks, explain how to extend them, and document external drag-and-drop after implementing uploadFile. Done means all three missing topics are covered accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.