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

Request Review #76

Closed
wants to merge 6 commits into from
Closed

Request Review #76

wants to merge 6 commits into from

Conversation

aFuzzyBear
Copy link
Contributor

@aFuzzyBear aFuzzyBear commented Jul 14, 2021

I had noticed that the button on the docs site wasnt working and there was a weird bug with the sidebar appearing as null and so the offsetTop wasn't being applied on the SiteSidebar.astro , I then made the side more fluid, sorry to report I had to change some of the styling for the width constraints placed on the text and font sizing, otherwise everything is as it was. Applied a basic toggle to the button to make the sidebar appear. (possible resolve issue #29 )

I'm going through with some copywriting for the pages atm,

If someone could review these and let me know if it was okay to do these edits, more importantly if they were done right.

@vercel
Copy link

vercel bot commented Jul 14, 2021

@aFuzzyBear is attempting to deploy a commit to the Pika Team on Vercel.

A member of the Team first needs to authorize it.

@@ -9,7 +9,8 @@ Astro includes an opinionated folder layout for your project. Every Astro projec
- `public/*` - Your non-code assets (fonts, icons, etc.)
- `package.json` - A project manifest.

The easiest way to set up your new project is with `npm init astro`. Check out our [Installation Guide](/quick-start) for a walkthrough of how to set up your project automatically (with `npm init astro`) or manually.
The easiest way to set up your new project is with `npm init astro`. Check out our [Installation Guide](/quick-start) for a walk-through of how to set up your project automatically (with `npm init astro`) or manually.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

"walkthrough" is a double barrell word, "walk-through"

Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM! 🎉


`npm init astro` is the easiest way to install Astro in a new project. Run this command in your terminal to start our `create-astro` install wizard to walk you through setting up a new project.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

your a wizard harry,

Copy link
Contributor

@rebelchris rebelchris left a comment

Choose a reason for hiding this comment

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

Some small changes, but overal the proposed changes look good to me!

public/index.css Outdated
Comment on lines 13 to 17
/* @media (min-width: 50em) {
:root {
--max-width: 46em;
}
}
} */
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this not be completely removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

aye man, however im not sure about the github etiquette for such things. So I was swithering if I should remove someone else's code or just comment it out, I thought I would go for the later, if it was approved then I would look to remove them,

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh not too sure, but since Git will keep history I always tend to just remove obsolete code right away.

public/index.css Outdated
Comment on lines 24 to 29
/* font-size: 1rem; */
/* font-size: clamp(
0.875rem,
0.4626rem + 1.0309vw + var(--user-font-scale),
1.125rem
);
); */
Copy link
Contributor

Choose a reason for hiding this comment

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

Here as well, complete removal right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ill go and remove these then, brb

Comment on lines 256 to 257
const btn = document.querySelector('#menu-toggle')
const sidebar = document.querySelector('#sidebar-nav')
Copy link
Contributor

Choose a reason for hiding this comment

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

Alternate option is to use getElementById('menu-toggle');

It's not a massive difference, but general one should opt for the most "clear" solution as this article states:
https://careerkarma.com/blog/javascript-queryselector-vs-getelementbyid/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Noted, Ill have that changed man

btn.addEventListener('click',()=>{
menuOpen = !menuOpen
if(menuOpen){
sidebar.style.display="block"
Copy link
Contributor

Choose a reason for hiding this comment

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

Small lint thing, you're using double quotes here and single for none, I would opt for 1 choice

Copy link
Contributor Author

Choose a reason for hiding this comment

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

😅 that one was a slip,

@@ -3,58 +3,67 @@ layout: ~/layouts/Main.astro
title: Installation
---

There are a few different ways to install
There are a few ways to getting started with Astro. Outlined below are instructions on how to go about installing Astro either manually or by our Astro Installer.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would "to get started" not sound better in this sentence?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it is, ill make that ammendment

- **A text editor** - We recommend [VS Code](https://code.visualstudio.com/) with the [Astro extension](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode).
- **A terminal** - Astro is mainly accessed by terminal command-line.
- **Node.js** - [`v12.20.0`](https://nodejs.org/en/download/releases/), [`v14.13.1`](https://nodejs.org/en/download/),[ `v16.0.0`](https://nodejs.org/en/download/current/), or higher.
- **A text editor** - We recommend [VS Code](https://code.visualstudio.com/) with our own [Astro extension](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode) for the complete DX.
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps write out Developer Experience?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

tails it is, ill also get that amended bud

@aFuzzyBear
Copy link
Contributor Author

closing this down, to resubmit the ammended version of this PR, with the changes that @rebelchris mentioned,

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