microsoft / microsoft/vscode-docs

Missing File System API extension guide

Open
#5,498 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc-enhancement extensibility
Dominant language
Markdown
Stars
6.6k
Forks
5.8k
Avg merge
11h 43m
Merged PRs (30d)
123

Description

We're missing an extension guide for the File System API, which is currently only referred to as an appendix
in the Virtual Documents guide.

cc @bpasero @jrieken

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

Start with the linked Virtual Documents guide and inspect its appendix reference to the File System API. Add a standalone extension guide covering that API, with the existing appendix reference replaced or updated so the documentation is no longer the only place it is mentioned.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.