Skip to content

Commit

Permalink
Fix broken links in React components
Browse files Browse the repository at this point in the history
  • Loading branch information
samglover committed Nov 20, 2024
1 parent 4d0940b commit 431d216
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/components/ALKiln/components/_need_proxy_vars.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
If your interview uses [generic objects](https://docassemble.org/docs/fields.html#generic) (`x`) or [index variables](https://docassemble.org/docs/fields.html#index%20variables) (`i`, `j`, `k`, etc), you **must** have [special HTML](../writing_tests.mdx#special-html) in your interview to set the values of variables.
If your interview uses [generic objects](https://docassemble.org/docs/fields.html#generic) (`x`) or [index variables](https://docassemble.org/docs/fields.html#index%20variables) (`i`, `j`, `k`, etc), you **must** have [special HTML](writing#special-html) in your interview to set the values of variables.

<!-- TODO: help wanted: This is true as long as they don't literally use `x` or `i`. I'm not sure how to express that complexity. -->
12 changes: 6 additions & 6 deletions docs/components/ALKiln/components/_scenario_folder_contents.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ export const ScenarioDir = () => {
return (
<ul>
<li>
An individual <Link to="writing_tests.mdx#report">report.txt</Link>
An individual <Link to="writing#report">report.txt</Link>
</li>
<li>
Another copy of <Link to="writing_tests.mdx#error-pics">error screenshots and html files</Link>
Another copy of <Link to="writing#error-pics">error screenshots and html files</Link>
</li>
<li>
<Link to="writing_tests.mdx#pic">Pictures you took of screens along with their associated HTML files</Link>
<Link to="writing#pic">Pictures you took of screens along with their associated HTML files</Link>
</li>
<li>
<Link to="writing_tests.mdx#download">Files you downloaded</Link>
<Link to="writing#download">Files you downloaded</Link>
</li>
<li>
<Link to="writing_tests.mdx#compare-json">JSON variables you compared</Link>
<Link to="writing#compare-json">JSON variables you compared</Link>
</li>
<li>
<Link to="writing_tests.mdx#a11y-all">Accessibility failures</Link>
<Link to="writing#a11y-all">Accessibility failures</Link>
</li>
</ul>
);
Expand Down
2 changes: 1 addition & 1 deletion docs/components/ALKiln/components/_secure_env_vars.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Since [workflow environment variables](../writing_tests.mdx#env-vars) might hold sensitive information, ALKiln avoids taking pictures or downloading the HTML of pages that use environment variables, even when the test has an error on that page. ALKiln avoids printing the value of an environment variable anywhere in the [report](../writing_tests.mdx#reports) or in the [console log](../writing_tests.mdx#console).
Since [workflow environment variables](writing#env-vars) might hold sensitive information, ALKiln avoids taking pictures or downloading the HTML of pages that use environment variables, even when the test has an error on that page. ALKiln avoids printing the value of an environment variable anywhere in the [report](writing#reports) or in the [console log](writing#console).

<!--
TODO: ALKiln:
Expand Down
6 changes: 3 additions & 3 deletions docs/components/ALKiln/components/_test_types.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export const GTOYS = (props) => {
if ( props.plain === true ) {
return <span>GitHub+You™</span>
} else {
return <Link to="setup.mdx#githubNyou-details">GitHub+You™</Link>
return <Link to="setup#githubNyou-details">GitHub+You™</Link>
}
}

Expand All @@ -15,7 +15,7 @@ export const AutoDIY = (props) => {
if ( props.plain === true ) {
return <span>ALKilnInThePlayground™</span>
} else {
return <Link to="setup.mdx#diy-details">ALKilnInThePlayground™</Link>
return <Link to="setup#diy-details">ALKilnInThePlayground™</Link>
}
}

Expand All @@ -24,6 +24,6 @@ export const KittyLitter = (props) => {
if ( props.plain === true ) {
return <span>GitHub Sandbox™</span>
} else {
return <Link to="setup.mdx#sandbox-details">GitHub Sandbox™</Link>
return <Link to="setup#sandbox-details">GitHub Sandbox™</Link>
}
}
2 changes: 1 addition & 1 deletion docs/components/ALKiln/components/_with_secrets.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
If you have an organization and want to use these values in multiple repositories, you can use [organization GitHub secrets](../writing_tests.mdx#org-secrets). In that case, your workflow file code would look more like this:
If you have an organization and want to use these values in multiple repositories, you can use [organization GitHub secrets](writing#org-secrets). In that case, your workflow file code would look more like this:
4 changes: 2 additions & 2 deletions docs/components/ALKiln/writing_tests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If you are writing tests <!-- , running tests, --> or need to learn about test f

If you are coming back and just need some resource reminders, here is a short list:

- You can see [what your first test might look like](alkiln_setup#first-test).
- You can see [what your first test might look like](setup.mdx#first-test).
- You can generate a first draft for a more complex test with the help of the [ALKiln Story Table Step generator](#alkiln_story).
- If your interview is using generic objects or index variables, you **must** include [special HTML](#special-html) in your interview.
- Every time you change or add a required field variable, you must update the tests that need that variable.
Expand Down Expand Up @@ -2537,7 +2537,7 @@ If your package is leaving out the al_package.yml file from the Assembly Line pa
### Testing unfinished code {#unstable-tip}
If you are still developing your interview, you can still write a [simple test](alkiln_setup#first-test) to make sure your interview at least loads without an error. You might want to wait till your code is more stable to write more tests.
If you are still developing your interview, you can still write a [simple test](setup.mdx#first-test) to make sure your interview at least loads without an error. You might want to wait till your code is more stable to write more tests.
On the other hand, if there is a part of your interview that you think will stay pretty much the same, you can write tests that just go part-way through the interview to test just the stable part of the code. That way, you can work on adding more content and yet also be sure that the work you've already done stays working.
Expand Down

0 comments on commit 431d216

Please sign in to comment.