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

No online docs #51

Open
xElfenlied opened this issue May 5, 2020 · 1 comment
Open

No online docs #51

xElfenlied opened this issue May 5, 2020 · 1 comment
Labels
type: docs Improvements or additions to documentation.

Comments

@xElfenlied
Copy link

docs.nrelay.net seems to be offline..
and "The code in the src/ folder has extensive inline documentation..." with only 1 example... where can i check what the tool is able to... (enter portals/ move/ pick up stuff/etc...)

@thomas-crane
Copy link
Owner

Hi @xElfenlied,

As I was not actively working on nrelay for some time, I didn't bother to renew the nrelay.net domain and it has since expired. The docs are still hosted on Firebase and you can access them from either https://nrelay-docs.web.app/ or https://nrelay-docs.firebaseapp.com/

When I say "inline documentation", I am referring to the JSDoc comments. It is these comments which are extracted by the TypeDoc tool and turned into the documentation website. If you are interested in finding some examples of what is possible with nrelay, it might be better to look in the docs folder of the main repo. There you will find some example plugins, and some docs about how to use other parts of nrelay.

I will leave this issue open until I have updated the links to the documentation to point to the right domain.

@thomas-crane thomas-crane added the type: docs Improvements or additions to documentation. label May 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvements or additions to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants