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

Add redirection to documentation #136

Merged
merged 1 commit into from
Apr 25, 2020

Conversation

yannbertrand
Copy link
Contributor

I struggled to find the documentation which is on https://covid-response-projects.github.io/covid-respirator/docs/software/firmware/html/files.html.

This PR should add a redirection from https://covid-response-projects.github.io/covid-respirator/docs/ to the real documentation.

May even be better to do it on /covid-respirator/ by removing the docs target folder and copy it as well.

It should be working as I got the file copied on https://github.com/yannbertrand/covid-respirator/tree/gh-pages/docs 🙂.

@jabby jabby requested a review from valeriansaliou April 9, 2020 21:58
@eliottvincent eliottvincent self-requested a review April 12, 2020 12:46
Copy link
Member

@eliottvincent eliottvincent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. We may have more docs in the future (mechanical parts, controller software, etc).
So I think it's better to redirect from https://covid-response-projects.github.io/covid-respirator/docs/firmware/ instead.

@yannbertrand yannbertrand force-pushed the master branch 2 times, most recently from a8b80e8 to 3ff2124 Compare April 13, 2020 12:10
@yannbertrand
Copy link
Contributor Author

Thanks for the review. I just updated the PR, lmk if I can change anything else!

@jabby jabby requested a review from eliottvincent April 13, 2020 17:04
eliottvincent
eliottvincent previously approved these changes Apr 24, 2020
@eliottvincent
Copy link
Member

Looks nice now. Could you please resolve the conflicts in .github/workflows/software-docs.yml?

@eliottvincent eliottvincent dismissed their stale review April 24, 2020 11:27

Waiting for conflit resolution

@eliottvincent eliottvincent merged commit ad27a59 into makers-for-life:master Apr 25, 2020
@eliottvincent
Copy link
Member

@yannbertrand Our CI "Firmware Documentation" job failed following the merge. The redirection file had a bad extension (.html instead of .html). Should work now.

@yannbertrand
Copy link
Contributor Author

Sorry about that. Thanks for fixing it!

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

Successfully merging this pull request may close these issues.

2 participants