Skip to content

Mkdocs setup #1392

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
Merged
merged 4 commits into from
May 17, 2022
Merged

Mkdocs setup #1392

merged 4 commits into from
May 17, 2022

Conversation

meatballhat
Copy link
Member

What type of PR is this?

  • cleanup
  • documentation

What this PR does / why we need it:

Adds initial mkdocs material configuration and index doc so that a docs site may be hosted via GitHub Pages.

Which issue(s) this PR fixes:

Fixes #1343
Fixes #1380

Special notes for your reviewer:

There was some mention in #1343 about possibly using docusaurus, but I threw this together given that other maintainers are either already familiar with mkdocs or prefer it to docusaurus.

@meatballhat meatballhat added kind/documentation describes a documentation update area/v2 relates to / is being considered for v2 kind/cleanup describes internal cleanup / maintaince labels May 8, 2022
@meatballhat meatballhat added this to the Release 2.x milestone May 8, 2022
@meatballhat meatballhat requested a review from a team as a code owner May 8, 2022 15:42
@meatballhat meatballhat mentioned this pull request May 8, 2022
Closed
3 tasks
rliebz
rliebz previously approved these changes May 8, 2022
View reviewed changes
@meatballhat meatballhat requested a review from rliebz May 9, 2022 01:57
@meatballhat
Copy link
Member Author

FYI out of band I've enabled GitHub Pages and added a CNAME record of:

cli.urfave.org. 3600 IN CNAME urfave.github.io.

@saintmalik
Copy link

FYI out of band I've enabled GitHub Pages and added a CNAME record of:

cli.urfave.org. 3600 IN CNAME urfave.github.io.

Great, nice, sorry it took me some days to respond, can i help out also?

@saintmalik
Copy link

Also noticed something: the pen editing button leads to a 404 page at the moment.

https://github.com/urvafe/cli/edit/main/docs/v2/index.md

@meatballhat
Copy link
Member Author

@saintmalik What do you think of this PR? Reasonable enough as a first attempt?

@meatballhat meatballhat requested a review from a team May 14, 2022 01:02
@saintmalik
Copy link

Yeah, its pretty awesome, and makes life easy for everyone

@kolyshkin
Copy link
Contributor

Hint: if you use git pull --rebase you can get rid of merge commits.

@meatballhat
Copy link
Member Author

Hint: if you use git pull --rebase you can get rid of merge commits.

@kolyshkin yep I'm aware 😁 I realize the whole merge/rebase debate has a long history that I definitely don't want to engage in here. Suffice to say I'm in favor of adapting my preferences to what works for fellow contributors. Any chance you're up for opening a discussion if you'd like to see a rebase-centric set of workflows and norms?

@meatballhat meatballhat merged commit 97a222b into main May 17, 2022
@meatballhat meatballhat deleted the mkdocs-setup branch May 17, 2022 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rliebz rliebz Awaiting requested review from rliebz

Assignees
No one assigned
Labels
area/v2 relates to / is being considered for v2 kind/cleanup describes internal cleanup / maintaince kind/documentation describes a documentation update
Projects
None yet
Milestone
Release 2.x
Development

Successfully merging this pull request may close these issues.

Drop markdown-toc in favor of default GitHub toc Responsive and friendly Documentation page
4 participants
@meatballhat @saintmalik @kolyshkin @rliebz