Skip to content

New docs#7205

Merged
jekyllbot merged 37 commits intojekyll:masterfrom
mneumegen:new-docs
Sep 1, 2018
Merged

New docs#7205
jekyllbot merged 37 commits intojekyll:masterfrom
mneumegen:new-docs

Conversation

@mneumegen
Copy link
Copy Markdown
Contributor

@mneumegen mneumegen commented Aug 29, 2018

Large overhaul of the docs.

This PR is my attempt to:

  • Reorganize the main navigation to make it easier to navigate
  • Separate longer pages into subpages to help readability
  • Add documentation for layouts
  • Add a showcase section to display sites using Jekyll
  • Add a step by step tutorial to walk new users through using Jekyll
  • Fix all HTML proofer errors
  • Reduce redundant/repeated content
  • Make existing content more succinct.

@mneumegen
Copy link
Copy Markdown
Contributor Author

You can find a built version these docs here.

@pathawks pathawks requested a review from a team August 29, 2018 22:55
@ghost ghost self-requested a review August 30, 2018 07:41
Copy link
Copy Markdown
Member

@DirtyF DirtyF left a comment

Choose a reason for hiding this comment

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

Great work, Showcase could use some lazyloading or pagination, but we can tackle this later.

@DirtyF
Copy link
Copy Markdown
Member

DirtyF commented Aug 30, 2018

@mneumegen I didn't compare the two sitemaps, but looks there are not so much redirections from actual URLs to handle, also Docsearch will quickly index the new site, so search shouldn't be impacted more than 24 hours.

Copy link
Copy Markdown

@ghost ghost left a comment

Choose a reason for hiding this comment

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

thanks for this! one request, we have a team page at /team that isn't linked anywhere. could you link it somewhere, maybe in the header or the footer? thanks!

anyways, here's my painstakingly long review

@ashmaroli

This comment has been minimized.

@mneumegen
Copy link
Copy Markdown
Contributor Author

@ashmaroli What did you have in mind for pagination? The examples are pretty verbose but that's just the nature of using that plugin.

mneumegen and others added 3 commits August 30, 2018 13:52
  * normalize markup indentation
  * fold long lines in code examples to the following line to improve readability
@ashmaroli
Copy link
Copy Markdown
Member

What did you have in mind for pagination?

@mneumegen I have made the changes myself, to avoid polluting this PR with unnecessary discussions..

</a>
{% else %}
<a href="{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}">{{ page }}</a>
<a href="{{ site.paginate_path | relative_url }}">{{ page }}</a>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

what about the last replace filter here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good catch @DirtyF!! I did not see that at all.. 😛

Copy link
Copy Markdown

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Don't wanna stop this massive PR from landing, we can make smaller changes afterwards.

@daviddarnes
Copy link
Copy Markdown
Member

@mneumegen great work Mike! Apologies I wasn't able to provide much feedback

@DirtyF
Copy link
Copy Markdown
Member

DirtyF commented Sep 1, 2018

@jekyllbot: :shipit: +docs

@jekyllbot jekyllbot merged commit 805f438 into jekyll:master Sep 1, 2018
jekyllbot added a commit that referenced this pull request Sep 1, 2018
@jekyll jekyll locked and limited conversation to collaborators Sep 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants