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 read the docs button to the home page #64

Closed
astrophpeter opened this issue Jul 28, 2022 · 1 comment · Fixed by #108
Closed

Add read the docs button to the home page #64

astrophpeter opened this issue Jul 28, 2022 · 1 comment · Fixed by #108
Assignees
Labels
Difficulty: entry level feature request Use on issues that use the feature request template Slim stack Working on this only requires the blast web and database

Comments

@astrophpeter
Copy link
Collaborator

🚀 Feature Request

Is your feature request related to a problem? Please describe.

  • We want to make the documentation for blast super easy to find.

Describe the solution you'd like


Describe alternatives you've considered


Additional context

@astrophpeter astrophpeter added feature request Use on issues that use the feature request template Difficulty: entry level Slim stack Working on this only requires the blast web and database labels Jul 28, 2022
@astrophpeter
Copy link
Collaborator Author

astrophpeter commented Jul 29, 2022

Start reading here: https://blast.readthedocs.io/en/latest/dev_running_blast.html

You should only need to run the slim stack for this change to see if your button works. :-)

To complete this task: Specifically, add something like this after this line: https://github.com/astrophpeter/blast/blob/6effacfdf2979f38ba2de775817bd1224392abab/app/host/templates/host/index.html#L12

to the code:


<a href="https://blast.readthedocs.io/en/latest/index.html" role="button" class="btn btn-primary">Read the docs <i class=""bi bi-book-half""></i></a>

Feel free to customize color etc make sure it is on the same line as the search the blast database button, and make sure it links to the docs.

To add the code, follow the developer workflow here: https://blast.readthedocs.io/en/latest/dev_workflow.html

Feel free to ask any questions you have on this thread :)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: entry level feature request Use on issues that use the feature request template Slim stack Working on this only requires the blast web and database
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants