Skip to content

[🚀site]: ts-doc based interactive documentation mechanism #451

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

Open
ala-n opened this issue Sep 3, 2021 · 0 comments · May be fixed by #1250
Open

[🚀site]: ts-doc based interactive documentation mechanism #451

ala-n opened this issue Sep 3, 2021 · 0 comments · May be fixed by #1250
Assignees
Labels
feature New feature postponed Postponed issue

Comments

@ala-n
Copy link
Collaborator

ala-n commented Sep 3, 2021

As a dev ESL consumer, I want to see interactive detailed docs of ESL code.

It is requested to add the ability to insert autogenerated interactive docs sections on the demo pages.

Create a custom shortcut for templates, e.g.
{# tsDoc 'src/module/all.ts' #}

  • Use passed root file to build TS project tree to parse TS Docs.
  • Pare the tree and aggregate Modules (files), Classes, Methods and Properties definition.
  • Render documentation using njk template and result definitions.

(Splitting candidate)

@ala-n ala-n added the feature New feature label Sep 3, 2021
@ala-n ala-n added this to the GH Pages Site Content milestone Sep 3, 2021
@fshovchko fshovchko linked a pull request Jan 12, 2022 that will close this issue
@fshovchko fshovchko linked a pull request Sep 28, 2022 that will close this issue
@ala-n ala-n linked a pull request Oct 14, 2022 that will close this issue
@ala-n ala-n removed this from the 🍀 GH Pages Redesign Enhancements milestone Aug 8, 2023
@ala-n ala-n added the postponed Postponed issue label Aug 8, 2023
@ala-n ala-n changed the title [🚀gh-pages]: ts-doc based interactive documentation mechanism [🚀site]: ts-doc based interactive documentation mechanism Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature postponed Postponed issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants