Skip to content

Commit

Permalink
fix bad links and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewreifman committed Jul 15, 2024
1 parent 0674589 commit 34640ae
Show file tree
Hide file tree
Showing 18 changed files with 27 additions and 95 deletions.
8 changes: 4 additions & 4 deletions developer/reference/components/react-runtime-provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ title: "<ReactRuntimeProvider>"
description: The `<ReactRuntimeProvider>` component takes a Makeswift runtime and provides it to the [`<Page>`](/reference/components/page) component for rendering snapshots.
---

import AppProviders from "/snippets/app-router/providers.mdx"
import AppLayout from "/snippets/app-router/layout.mdx"
import PagesApp from "/snippets/pages-router/pages-app.mdx"
import AppProviders from "/snippets/app-router/providers.mdx";
import AppLayout from "/snippets/app-router/layout.mdx";
import PagesApp from "/snippets/pages-router/pages-app.mdx";

## Props

<ParamField query="runtime" type="Runtime" required>
A Makeswift [runtime](/reference/runtime/constructor.mdx).
A Makeswift [runtime](/reference/runtime/constructor).
</ParamField>

<ParamField query="children" type="React.Node">
Expand Down
6 changes: 3 additions & 3 deletions product/SEO.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ change.

- **Always:** Used for pages that change constantly, such as live data feeds.
- **Hourly:** For pages that update every hour.
- **Daily:** For pages that change daily,such as news articles or blogs.
- **Daily:** For pages that change daily, such as news articles or blogs.
- **Weekly:** For pages that are updated weekly.
- **Monthly:** For pages with monthly updates.
- **Yearly:** For pages with annual updates.
Expand Down Expand Up @@ -103,7 +103,7 @@ Internal linking structure refers to the way links are organized within your web

### Image optimization

Optimize image file names and alt text to improve accessibility and provide additional context for search engins. Files names can be managed through the [files](/product/files) manager and alt tags can be managed on each individual image within a page.
Optimize image file names and alt text to improve accessibility and provide additional context for search engines. File names can be managed through the [files](/product/files) manager and alt tags can be managed on each individual image within a page.

<Frame>
![File naming and image alt text
Expand Down Expand Up @@ -143,7 +143,7 @@ More advanced SEO requirements will need to be managed directly in your codebase

<Warning>The following can only be administered using a custom host</Warning>

### `Robots.txt`
### `robots.txt`

The `robots.txt` file is used to ensure that search engines can crawl a new site properly and that sensitive or duplicate content is blocked as necessary.

Expand Down
8 changes: 0 additions & 8 deletions product/component/property-controls/backgrounds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,3 @@ Use videos hosted on the following streaming platforms as backgrounds:
Add a video by copying and pasting the link from your browser's URL bar from any of the above mentioned platforms. Background videos are set to autoplay, and are looped and muted by default.

<Frame>![Background Videos](/images/builder/backgrounds1.gif)</Frame>

## Examples

<Note>For examples on how to use these. Need to put something here?</Note>

## Pro tips

Combine colors and images with opacity
2 changes: 0 additions & 2 deletions product/component/property-controls/corners.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ In Makeswift, you're able to select which corners you want to change the radius

<Frame>![Selecting different corners](/images/builder/corners2.gif)</Frame>

The more rounded a corner the friendlier the design. Maybe show examples of two different cards with varying corner radiuses

## Shortcuts

While dragging the panel inputs for individual corners, hold the `⌥ Option` or `Alt` key to equally change parellel corners of an element. Hold `⇧ Shift + ⌥ Option` or `Alt` to equally change all corners.
Expand Down
4 changes: 2 additions & 2 deletions product/component/property-controls/gap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Gap is an easier way to uniformly control spacing between an elements contents.

## Row gap

Row gap refers to the distance between elements stacked on top of each other
Row gap refers to the distance between elements stacked on top of each other.

## Column gap

Column gap refers to the distance between elements placed next to each other
Column gap refers to the distance between elements placed next to each other.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion product/component/property-controls/padding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ cause your content to be squished on smaller devices.

## Shortcuts

While dragging the handles or inputs, hold the `⌥ Option` or `Alt` key to equally change margin on both sides of an element. Hold `⇧ Shift + ⌥ Option` or `Alt` to equally change margin for all sides.
While dragging the handles or inputs, hold the `⌥ Option` or `Alt` key to equally change padding on both sides of an element. Hold `⇧ Shift + ⌥ Option` or `Alt` to equally change padding for all sides.

<Frame>![⌥ Option (or Alt) hotkey](/images/builder/padding7.gif)</Frame>

Expand Down
4 changes: 0 additions & 4 deletions product/component/property-controls/shadows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,3 @@ You can change the color and angle of your shadow to add a glowing effect to a s
Avoid importing assets with shadows included in the original file, as this can be added in Makeswift.

Another tip is to lower the color opacity and use a higher blur to create softer, more realistic shadows.

## Developer notes

Since Shadows can be added to almost anything, it may not make sense to add shadows to your component if it isn't controllable within Makeswift. Unless you have multiple shadows within your component, it will likely be better handled in Makeswift.
6 changes: 3 additions & 3 deletions product/files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ icon: "folder-open"
You can perform actions on multiple files at once to streamline your workflow.

1. **Select Files:** Click the checkbox next to each file you want to select.
2. **Perform Actions:** Use the action buttons (delete, move, download) at the top of the file manager to perform bulk actions on the selected files.
2. **Perform Actions:** Use the action buttons (delete, move, download) at the top of the files manager to perform bulk actions on the selected files.

## Drag and drop

Easily move files and folders within the file manager by using the drag-and-drop feature.
Easily move files and folders within the files manager by using the drag-and-drop feature.

1. **Select a File or Folder:** Click and hold the file or folder you want to move.
2. **Drag to New Location:** Drag the selected item to the desired location within the file manager.
2. **Drag to New Location:** Drag the selected item to the desired location within the files manager.
3. **Drop to Move:** Release the mouse button to drop the item into the new location.

## Sorting
Expand Down
4 changes: 2 additions & 2 deletions product/layouts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ icon: "table-layout"

## Creating a layout inside of a Box

When you first drop a [Box](product/toolbar/box.mdx) onto your page, it will appear as an empty rectangle. You can add any number of components into a box. Components placed side-by-side create columns, and ones placed above and below create new rows.
When you first drop a [Box](/product/components#box) onto your page, it will appear as an empty rectangle. You can add any number of components into a box. Components placed side-by-side create columns, and ones placed above and below create new rows.

<Frame>![Creating layouts with boxes](/images/builder/layouts1.gif)</Frame>

Expand Down Expand Up @@ -66,7 +66,7 @@ Overlays are controls placed directly on components in the canvas to allow you t
![Padding in the panel](/images/builder/Overlays4.gif)
</Frame>

You can also easily remove a box's padding by clicking the blue Padding label in the panel and selecting "Reset to base". This also works for all panels in Makeswift. In smaller devices, blue panel labels will display options to [reset to larger breakpoints](/product/device-toggle).
You can also easily remove a box's padding by clicking the blue Padding label in the panel and selecting "Reset to base". This also works for all panels in Makeswift. In smaller devices, blue panel labels will display options to [reset to larger breakpoints](/product/responsive-design).

<Frame>
![Reset padding to base](/images/builder/Overlays5.gif)
Expand Down
10 changes: 5 additions & 5 deletions product/localization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,27 @@ Makeswift's localization feature allows you to manage localized versions of your
Open site settings and go to the "Locales" tab.

<Frame>
![Localization first step](../images/localization-first-step.png)
![Localization first step](/images/localization-first-step.png)
</Frame>

To add a new locale, click the "+ Add locale" button. You can modify or delete existing locales by hovering over the locale:

<Frame>
![Hovering over the locale](../images/localization-hover-locale.png)
![Hovering over the locale](/images/localization-hover-locale.png)
</Frame>

You can also modify the default locale by hovering over it and clicking the edit button.

Here's an example of what a list of locales in settings looks like:

<Frame>
![Manage locales in settings](../images/localization-manage-locales.png)
![Manage locales in settings](/images/localization-manage-locales.png)
</Frame>

</Step>

<Step title="Configure locales in your Next.js config">
For detailed instructions on setting up locales, see our [developer docs](https://docs.makeswift.com/pages-router/localization#localized-resources) on localization.
For detailed instructions on setting up locales, see our [developer docs](/developer/app-router/localization) on localization.

</Step>

Expand All @@ -48,7 +48,7 @@ Makeswift's localization feature allows you to manage localized versions of your
Once you've finished setting up your locales in Makeswift and in your codebase, you should be able to switch to different locales using the locale switcher in the builder browser bar.

<Frame>
![Manage locales in settings](../images/localization-locales-switcher.png)
![Manage locales in settings](/images/localization-locales-switcher.png)
</Frame>

When making changes in a different locale you can override any property, including the page's pathname, metadata, and SEO tags.
Expand Down
54 changes: 0 additions & 54 deletions product/overlays.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion product/page/metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ When unchecked, this will set the robots metadata to be `index, follow`. When ch

## Developer notes

Additional SEO panels can be added to the `<Page>` copmonent within a custom host. View the [developer docs](/developer/reference/components/seo) for more information.
Additional SEO panels can be added to the `<Page>` component within a custom host. View the [developer docs](/developer/reference/components/page) for more information.
2 changes: 1 addition & 1 deletion product/page/paths.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For your homepage, you will likely not have a pathname. This is signified by a s

## Localization

When utilizing the [localization](product/site/localization.mdx) feature, you may translate or alter path names within each locale as if they are separate pages. By default, each locale will inherit the path name of the base locale.
When utilizing the [localization](/product/localization) feature, you may translate or alter path names within each locale as if they are separate pages. By default, each locale will inherit the path name of the base locale.

## Pro tips

Expand Down
2 changes: 1 addition & 1 deletion product/responsive-design.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ icon: "laptop-mobile" iconType: "solid"

## Designing for mobile and tablet

In Makeswift, styles always cascade from larger devices to smaller ones. Once a style has been overriden on a smaller device, that specific style will no longer be affected by changes from a larger device. All element and text styles can be set per device. Things such as text content, images, sorting elements, or changing links are not responsive.
In Makeswift, styles always cascade from larger devices to smaller ones. Once a style has been overridden on a smaller device, that specific style will no longer be affected by changes from a larger device. All element and text styles can be set per device. Things such as text content, images, sorting elements, or changing links are not responsive.

Select an element and switch to a smaller device. If a style is being inherited from a larger device, the label for it's panel will be gray.

Expand Down
2 changes: 1 addition & 1 deletion product/site/colors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ To manage colors, deselect all elements and navigate to the "Site" tab in the ri

## Developer notes

When creating components you can add a custom panel using the [color](developer/reference/controls/colors/color.mdx) control to allow your team to select from your site colors.
When creating components you can add a custom panel using the [color](/developer/reference/controls/color) control to allow your team to select from your site colors.
2 changes: 1 addition & 1 deletion product/site/domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Here is DNS help documentation for several common domain providers:
- [Domain.com](https://www.domain.com/help/article/dns-management-how-to-update-dns-records)
- [eNom](https://help.enom.com/hc/en-us/articles/115000474012-How-to-Change-DNS-Host-Records)
- [GoDaddy](https://www.godaddy.com/help/view-my-dns-settings-19182)
- [NameCheap](https://www.namecheap.com/support/knowledgebase/article.aspx/434/2237/how-do-i-set-up-host-records-for-a-domain)
- [Namecheap](https://www.namecheap.com/support/knowledgebase/article.aspx/434/2237/how-do-i-set-up-host-records-for-a-domain)
- [Network Solutions](https://www.networksolutions.com/support/how-to-manage-advanced-dns-records/)

## Setting a primary domain
Expand Down
2 changes: 1 addition & 1 deletion product/site/hosting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ You can still connect a custom domain with default hosting, but you may encounte

Setting up a custom host gives you full flexibility with Makeswift. You can use features such as [localization](/product/localization), [custom breakpoints](/developer/reference/runtime/constructor#custom-breakpoints), and [adding custom components](/product/components).

For help setting up a custom host visit our [developer docs](https://docs.makeswift.com/pages-router/installation).
For help setting up a custom host visit our [developer docs](/developer/app-router/installation).
2 changes: 1 addition & 1 deletion product/theming.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Theming"
description: "Theming is the concept of creating a style palette for your website. With [site colors](/product/site/colors) and [text styles](/product/site/text-styles) you can standardize the available stlyes for all users in your workspace to use."
description: "Theming is the concept of creating a style palette for your website. With [site colors](/product/site/colors) and [text styles](/product/site/text-styles) you can standardize the available styles for all users in your workspace to use."
icon: "palette"
---

Expand Down

0 comments on commit 34640ae

Please sign in to comment.