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

General updates #5

Merged
merged 3 commits into from
Oct 25, 2022
Merged

General updates #5

merged 3 commits into from
Oct 25, 2022

Conversation

pdmosses
Copy link
Contributor

@pdmosses pdmosses commented Oct 24, 2022

This PR aims to make the template easier to use for those new to Jekyll and the Just the Docs theme. The changes in this PR are merely my suggestions (based on my own lack of understanding of what terms like "deploy" really mean).

  • Updates the home page at index.md to give an overview of what the template can do.
  • Updates README.md to focus on how to do it (preview).
  • Minor polishing of .gitignore, _config.yml, and Gemfile.

When the template has been finalised, I'd like to add a reference to it on the theme home page.

@netlify
Copy link

netlify bot commented Oct 24, 2022

Deploy Preview for just-the-docs-template ready!

Name Link
🔨 Latest commit 27d468d
🔍 Latest deploy log https://app.netlify.com/sites/just-the-docs-template/deploys/6356f9bc0f5e27000903f64c
😎 Deploy Preview https://deploy-preview-5--just-the-docs-template.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@pdmosses
Copy link
Contributor Author

@mattxwang I don't see how to request a review for this PR in the usual way…

Copy link
Member

@mattxwang mattxwang left a comment

Choose a reason for hiding this comment

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

No worries on the requesting review portion; this LGTM. Left one nit but we can address post-merge.

webrick (1.7.0)

PLATFORMS
x86_64-darwin-19
Copy link
Member

Choose a reason for hiding this comment

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

99% sure we may need to also eventually add other platforms, but we can do that separately!

Copy link
Member

Choose a reason for hiding this comment

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

See: 88e466d

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mattxwang thanks for approving and merging this PR! I was expecting that you'd suggest some changes. Anyway, the template is something that we can easily update later, based on user feedback and experience.

When I next get a bit of spare time (hopefully this week) I'll try submitting a PR for the theme docs home page and README, referring to the template for details.

@mattxwang mattxwang merged commit 0aab805 into just-the-docs:main Oct 25, 2022
@mattxwang
Copy link
Member

When the template has been finalised, I'd like to add a reference to it on the theme home page.

PR welcome for that as well!

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.

2 participants