search

thoth-station / jupyterlab-requirements

JupyterLab Extension for dependency management and optimization
GNU General Public License v3.0
16 stars 9 forks source link

New docs for the API #607

Closed Gkrumbach07 closed 2 years ago

Gkrumbach07 commented 2 years ago

Is your feature request related to a problem? Please describe. There is not a maintainable docs in place.

Describe the solution you'd like I would like to implement something using TypeDoc. This would allow a mostly automatic way to get a basic api doc up and running. TypeDoc also allows you to use standard function headers to customize and further give detail to the functions and features in the app.

Describe alternatives you've considered A manual doc in the readme

Additional context Here is a quick docs of just two files in the app, without any extra details added to the functions. https://lucid-aryabhata-1b8089.netlify.app/

A more detailed example of what the docs could be with some extra effort can be found here: https://typedoc.org/example/

goern commented 2 years ago

/priority critical-urgent

Gkrumbach07 commented 2 years ago

/assign @Gkrumbach07 /lifecycle active

Gkrumbach07 commented 2 years ago

Docs will be available by running the command npx typedoc. Should we deploy the docs using GitHub Pages (essentially storing the HTML doc files in the repo ~3.8 MB). Or should we deploy it using an alternative method.

note: It is a basic static webpage, so it would be deployed similar to the way Thoth Search is deployed, except without the stage deployment.

cc @goern @fridex @pacospace

sesheta commented 2 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

sesheta commented 2 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

sesheta commented 2 years ago

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

/close

sesheta commented 2 years ago

@sesheta: Closing this issue.

In response to [this](https://github.com/thoth-station/jupyterlab-requirements/issues/607#issuecomment-1193051332): >Rotten issues close after 30d of inactivity. >Reopen the issue with `/reopen`. >Mark the issue as fresh with `/remove-lifecycle rotten`. > >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.