search

esong165 / cse110-w21-group25

2 stars 3 forks source link

add link to documentation to wiki #142

Closed ainesh01 closed 3 years ago

esong165 commented 3 years ago

Actually, is making this a new section fully necessary? If the section at the end of "Getting Started" isn't enough we could put some links there instead.

ainesh01 commented 3 years ago

Actually, is making this a new section fully necessary? If the section at the end of "Getting Started" isn't enough we could put some links there instead.

Whoops, I didn't see your response before requesting review. To be honest, I don't know what's really required, but I thought a separate section would help sim/whoever else is grading to find it easily.

esong165 commented 3 years ago

Can a third party give an opinion on this? I think we could just have [codebase]/[pipeline] link to their respective wiki pages in the last line of the "Getting Started" section.

DuckDuckWhaleUCSD commented 3 years ago

I'd like to take a middle ground and say that we both need more visibility on our wiki but also shouldn't add it to the end of the README since the context doesn't connect. I propose we add the documentation section to the end of the getting started section, and replace the brief explanation there with links to pipeline, docs, and members. If anyone has differing opinions please comment.

esong165 commented 3 years ago

I'm fine with that approach.

ainesh01 commented 3 years ago

Works for me, will take care of this tomorrow morning/afternoon.