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

Update docs for typescript->master merge & release #7

Open
jacobwindsor opened this issue Mar 2, 2017 · 4 comments
Open

Update docs for typescript->master merge & release #7

jacobwindsor opened this issue Mar 2, 2017 · 4 comments

Comments

@jacobwindsor
Copy link
Collaborator

The docs in the Typescript branch are out of date. There is now this UI component and some other changes.

@ariutta what needs to be on the docs? I am happy to update them but it would be good to have a starting point as to what needs to be done so i can investigate the corresponding code

@jacobwindsor jacobwindsor changed the title Update docs for typescript->master merge Update docs for typescript->master merge & release Mar 2, 2017
@jacobwindsor
Copy link
Collaborator Author

The 6.0.0-1 release is not working when installing via npm. I have fixed all of the issues in subsequent commits. I think it's best to just delete that release and make a new one.
Everything works fine now when using

"bridgedb": "git://github.com/bridgedb/bridgedbjs.git#c9c62df8487f49f1ad7a1c2614b6680d879331e7",

So a release on NPM should work

@ariutta
Copy link
Collaborator

ariutta commented Mar 2, 2017

Do you have an NPM account? I can add you to the bridgedb package.

@ariutta
Copy link
Collaborator

ariutta commented Mar 2, 2017

For the docs, I was originally using a tool that created docs from JSDoc comments. Now that we're using TS, we could look into using one of the documentation generators for TS, such as one of these:

https://www.npmjs.com/package/typedoc
https://www.npmjs.com/package/tsdoc

I'd like to keep the documentation in a separate branch (probably gh-pages). The source code branches like master and typescript should not put build artifacts like compiled JS and documentation under version control.

@ariutta
Copy link
Collaborator

ariutta commented Mar 2, 2017

On NPM, releases are pretty much immutable now. But we can always keep bumping the version. For deciding on version numbers, I'm trying to stick with semver: http://semver.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants