quick README.md update #1
Conversation
links to other sections in part 1 songbird standalone do not work - so I just wrote in the section name they should check to be fool proof.
|
The links should start working when this is merged into the biocore/songbird repo, so I don't think this is a problem. However, I do agree that the links should be a lot more foolproof than they are now. I'm going to see if I can use anchors to make more "stable" links. |
|
OK, I updated the links to use more stable anchors—so even if we mess around with the section titles, the links will stay the same. They're also "relative", so they'll work in fedarko/songbird, biocore/songbird, ... etc. e.g. https://github.com/fedarko/songbird#interpreting-model-fitting |
|
Great! Maybe to increase the fool proofness you can have the link on text that describes where its going (i.e. 'section 4') instead of 'this link' |
|
oops I guess we commented at the same time, sorry... my opinion is to avoid specifying the section number in the text, since that can change. How about e.g. "this section on interpreting model fitting"? That way even if the link breaks (which it shouldn't, now) the reader will still have an idea of where to go |
|
Ah right makes sense. OK that sounds good to me! |
links to other sections in part 1 songbird standalone do not work - so I just wrote in the section name they should check to be fool proof.