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.

Sign up for GitHub

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

Jump to bottom

How to edit docs? #460

Open
jamesbraza opened this issue Jan 20, 2024 · 2 comments · May be fixed by #461
Open

How to edit docs? #460

jamesbraza opened this issue Jan 20, 2024 · 2 comments · May be fixed by #461

Comments

@jamesbraza
Copy link

Looking at 99eba20#diff-fee45415ce1a1c290e697917da2b716532bcff66dbe1d9ae5caea30144bb0cc3, it's unclear what was the original docs file edited, and which are autogenerated:

  • MANUAL
  • MANUAL.markdown
  • doc/manual.html

Which file does one edit, and which make commands does one then run?
@jamesbraza
Copy link
Author

Cc @ch4rr0 and @BenLangmead. I am trying to upstream some info from #410 to the docs, so it can be closed.

@ch4rr0
Copy link
Collaborator

ch4rr0 commented Jan 20, 2024

Hello, you can submit a pull request that modifies MANUAL.markdown. MANUAL and manual.html are generated from the markdown file using pandoc (make doc). Once done I will then push updated documentation to the website.

@jamesbraza jamesbraza linked a pull request Jan 20, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added CONTRIBUTING.md explaining docs jamesbraza/bowtie2
2 participants
@jamesbraza @ch4rr0