Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Idea]: refactor generated TypeScript interface documentation #20

Open
kgryte opened this issue Jan 11, 2023 · 0 comments
Open

[Idea]: refactor generated TypeScript interface documentation #20

kgryte opened this issue Jan 11, 2023 · 0 comments
Labels
difficulty: 3 Likely to be challenging but manageable. idea Potential GSoC project idea. priority: normal Normal priority. tech: html/css Involves using HTML and CSS. tech: javascript Involves programming in JavaScript. tech: jsx/react Involves programming with React JSX. tech: nodejs Requires developing with Node.js. tech: typescript Involves programming in TypeScript.

Comments

@kgryte
Copy link
Member

kgryte commented Jan 11, 2023

Idea

Currently, stdlib publishes TypeScript interface documentation in its web-based API documentation. The generated documentation monkey-patches tsdoc to handle generating documentation across the entire mono-repo. The goal of this project is to refactor/rethink this approach and provide a solution capable of addressing the unique constraints of the stdlib project.

Expected Outcomes

At a base level, it would be great if we had a working documentation render which did not require monkey-patching. A more difficult, but potentially more desirable, outcome would be if TypeScript documentation was not rendered as a separate website, but rather was integrated within the docs as simply another page/fragment.

Involved Software

No other software is necessary.

Prerequisite Knowledge

JavaScript, Node.js, HTML/CSS, TypeScript, JSX/React.

Difficulty

Intermediate.

Project Length

175/350 hours. Length will depend on the nature of the proposed solution (e.g., needing to write a custom TypeScript parser vs modifying the existing tsdoc library).

Potential Mentors

@kgryte @Planeshifter @steff456

@kgryte kgryte added idea Potential GSoC project idea. priority: normal Normal priority. difficulty: 3 Likely to be challenging but manageable. tech: javascript Involves programming in JavaScript. tech: nodejs Requires developing with Node.js. tech: html/css Involves using HTML and CSS. tech: jsx/react Involves programming with React JSX. tech: typescript Involves programming in TypeScript. labels Jan 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: 3 Likely to be challenging but manageable. idea Potential GSoC project idea. priority: normal Normal priority. tech: html/css Involves using HTML and CSS. tech: javascript Involves programming in JavaScript. tech: jsx/react Involves programming with React JSX. tech: nodejs Requires developing with Node.js. tech: typescript Involves programming in TypeScript.
Projects
None yet
Development

No branches or pull requests

1 participant