You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is there a way to generate links to Github without having the repository? Say I download a zip file of the project and try to generate the documentation. We know the github url from the package.json
The generated docs may not be in sync since the code will not know what branch its supposed to look at. We could by default just make it point to master. Docs and code may be out of sync but that's a risk we are willing to take. To avoid this we could add another field to package.json specifying the branch name or commit to point it to or maybe an option in the command line.
Our internal doc generation involves using docker and we no longer have the repo when we make the docs and so all the links pointing to Github are not generated.
The text was updated successfully, but these errors were encountered:
Is there a way to generate links to Github without having the repository? Say I download a zip file of the project and try to generate the documentation. We know the github url from the package.json
The generated docs may not be in sync since the code will not know what branch its supposed to look at. We could by default just make it point to master. Docs and code may be out of sync but that's a risk we are willing to take. To avoid this we could add another field to package.json specifying the branch name or commit to point it to or maybe an option in the command line.
Our internal doc generation involves using docker and we no longer have the repo when we make the docs and so all the links pointing to Github are not generated.
The text was updated successfully, but these errors were encountered: