Restrict api methods with platform

Open
#447 5 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation, frontend

Research direction

The issue requests a platform filter for API documentation that affects both the main view and the sidebar. First map where API methods and platform metadata are rendered; done means selecting a platform hides nonmatching methods in both places.

Written by the indexing model from the issue text.

Description

:sparkles: enhancement area:docs

Not sure how many people this could benefit, but the docs could benefit from being able to hide methods that are platform specific. For example, I'm currently hired to develop for Windows only, and have to scroll through many macOS specific methods. It would be nice to filter both the view and the sidebar to a specific platform for faster reading.

Dominant language
TypeScript
Stars
157
Forks
207
Avg merge
4h 57m
Merged PRs (30d)
20

Contributor guide

No contributing guide indexed for this repository

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.

More from electron/website

All issues in electron/website

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.