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 support for shell documentation #467

Merged
merged 14 commits into from
May 7, 2019
Merged

Add support for shell documentation #467

merged 14 commits into from
May 7, 2019

Conversation

osterman
Copy link
Member

@osterman osterman commented May 4, 2019

what

  • Add support for man pages from markdown

why

  • Geodesic has insufficient documentation in part because we haven't had a good way to deliver it
  • Unix has solved this: man pages have been there forever. The problem is that man (groff) is no fun to write. Using pandoc we can convert markdown to valid man pages to make it easy to contribute documentation

references

@osterman osterman added the wip Work in Progress: Not ready for final review or merge label May 4, 2019
rootfs/usr/local/bin/docs Outdated Show resolved Hide resolved
Copy link
Member

@aknysh aknysh left a comment

Choose a reason for hiding this comment

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

nitpick

@osterman osterman requested a review from aknysh May 6, 2019 22:35
@osterman osterman removed the wip Work in Progress: Not ready for final review or merge label May 6, 2019
@osterman osterman merged commit 9f0f8d4 into master May 7, 2019
@osterman osterman deleted the add-man-pages branch May 7, 2019 06:01
@@ -1 +0,0 @@
77e3cde7afac220dbf00e433fbaf4abb
Copy link
Sponsor Contributor

Choose a reason for hiding this comment

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

You should not have an empty geodesic_apkindex.md5. Do you maybe have *.md5 in your global .gitignore?

Copy link
Member Author

Choose a reason for hiding this comment

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

I ran the update command but didn’t pay attention to the result. Will check what’s wrong next time.

leb4r pushed a commit that referenced this pull request Jan 25, 2022
Co-authored-by: osterman <osterman@users.noreply.github.com>
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.

3 participants