microsoft / microsoft/pxt-microbit

Feature: Improve contextual docs/reference workflow

Open
#3,884 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

performance sidedocs
Dominant language
TypeScript
Stars
804
Forks
721
Avg merge
2d 9h
Merged PRs (30d)
2

Description

Is your feature request related to a problem? Please describe.

  • The sideloaded docs are realy useful, but take a long time to open, which makes the experience of using them pretty frustrating

https://user-images.githubusercontent.com/31242877/108371681-e9e5a680-71f5-11eb-88cc-83ce1a12009f.mp4

  • It's not obvious you can open them in a new tab (which loads quicker) and if you do use a new tab, you are navigating away from your code.

  • When the tab is opened it obscures the code view

image

Describe the solution you'd like

  • Load the reference quicker
  • Make the side loading reference searchable. You can do this if you open the docs in a new tab (It would be good to have a native search instead of Bing)
image - Collapse/Expand simulator when docs are opened/closed to make it easier to see your blocks ![image](https://user-images.githubusercontent.com/31242877/108373346-b9067100-71f7-11eb-9b85-af53baf1be8e.png)

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

No files or tests are named. Start by locating the contextual docs/reference workflow and the simulator UI, then review how sideloaded docs are opened and searched. Done should cover faster loading, in-context search, clearer tab behavior, and simulator collapse or expansion without obscuring the code view.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.