Skip to content

Commit

Permalink
feat: update ideas list
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jan 30, 2024
1 parent 6891f68 commit 72f5681
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion ideas.md
Original file line number Diff line number Diff line change
Expand Up @@ -826,7 +826,14 @@ Linked issue: <https://github.com/stdlib-js/google-summer-of-code/issues/26>

### Idea

Currently, all code blocks in the documentation at https://stdlib.io/docs/api/latest is static. To make example code more useful and engaging, it would be nice to have interactive code shells on the website that could be edited and would provide real-time return annotations.
Currently, all code blocks in the documentation at https://stdlib.io/docs/api/latest are static. To make example code more useful and engaging, it would be nice to have interactive code shells on the website that could be edited and would provide real-time return annotations.

Some initial brainstorming has been done to inform how this would work, but, at minimum, we'd need to

- convert READMEs to structured data to allow for more straightforward transformation
- support dynamic loading of relevant stdlib packages used in example code blocks
- lazily integrate a code editor into documentation pages
- implement security measures to prevent malicious usage

### Expected Outcomes

Expand All @@ -848,6 +855,10 @@ Hard.

350 hours.

### Potential Mentors

@kgryte @Planeshifter @steff456

* * *

## Optimization Algorithms
Expand Down

0 comments on commit 72f5681

Please sign in to comment.