broken links and auto open faqs when linked

Author: vdikransamarjian

docs/capabilities/devvit-web/devvit_web_overview.mdx

@@ -35,7 +35,7 @@ As with most experimental features, there are some caveats.
 | Limitation                                       | What it means                                                                                                                                                                                                                                                                                           |
 | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | Serverless endpoints                             | The node server will run just long enough to execute your endpoint function and return a response, which means you can't use packages that require long-running connections like streaming.                                                                                                             |
-| Package limitations                              | Developers cannot use `fs` or external native packages. For now, we recommend using external services over the native dependencies, such as [StreamPot](https://streampot.io/) (instead of ffmpeg) and [OpenAI](https://platform.openai.com/docs/guides/embeddings) (instead of @xenova/transformers) . |
+| Package limitations                              | Developers cannot use `fs` or external native packages. For now, we recommend using external services over native dependencies. |
 | Single request and single response handling only | Streaming or chunked responses and websockets are not supported. Long-polling is supported if it's under the max request time.                                                                                                                                                                          |
 | No external requests from your client            | You can't have any external requests other than the app's webview domain. All backend responses are locked down to the webview domain via CSP. (Your backend can make external fetch requests though.)                                                                                                  |
 | localStorage clears on app updates               | The iframe URL changes with each app version, so `localStorage` data is lost when you publish an update. Use [Redis](../server/redis.mdx) for data that needs to persist across app versions.                                                                                                           |

docs/capabilities/server/redis.mdx

@@ -615,7 +615,7 @@ Redis transactions allow a group of commands to be executed in a single isolated
 - Increment the count for selected option.
 - Add the user to voted user list.
 
-The `watch` command provides an entrypoint for transactions. It returns a [TxClientLike](https://developers.reddit.com/docs/api/public-api/#-txclientlike) which can be used to call `multi`, `exec`, `discard`, `unwatch`, and all other Redis commands to be executed within a transaction.
+The `watch` command provides an entrypoint for transactions. It returns a [TxClientLike](https://developers.reddit.com/docs/api/public-api/type-aliases/TxClientLike) which can be used to call `multi`, `exec`, `discard`, `unwatch`, and all other Redis commands to be executed within a transaction.
 
 You can sequence all of the above steps in a single transaction using `multi` and `exec` to ensure that either all of the steps happen together or none at all.
 
@@ -626,7 +626,7 @@ If an error occurs inside a transaction before `exec` is called, Redis discards
 | [multi](https://redis.io/commands/multi/)     | Marks the start of a transaction block.                                                                                                                                                                                                         | Max concurrent transactions per installation: 20 (default) |
 | [exec](https://redis.io/commands/exec/)       | Executes all previously queued commands in a transaction and restores the connection state to normal.                                                                                                                                           | Transaction execution timeout: 5 seconds |
 | [discard](https://redis.io/commands/discard/) | Flushes all previously queued commands in a transaction and restores the connection state to normal.                                                                                                                                            | None |
-| [watch](https://redis.io/commands/watch/)     | Marks the given keys to be watched for conditional execution of a transaction. `watch` returns a [TxClientLike](https://developers.reddit.com/docs/api/public-api/#-txclientlike) which should be used to call Redis commands in a transaction. | None |
+| [watch](https://redis.io/commands/watch/)     | Marks the given keys to be watched for conditional execution of a transaction. `watch` returns a [TxClientLike](https://developers.reddit.com/docs/api/public-api/type-aliases/TxClientLike) which should be used to call Redis commands in a transaction. | None |
 | [unwatch](https://redis.io/commands/unwatch/) | Flushes all the previously watched keys for a transaction.                                                                                                                                                                                      | None |
 
 <details>

docs/devvit_rules.md

@@ -4,13 +4,13 @@
 
 Welcome to Reddit’s Developer Platform (or “**Devvit**”)! Before you build, please read these Devvit Rules along with Reddit’s [Developer Terms](https://www.redditinc.com/policies/developer-terms). We want you and your Devvit app(s) to succeed, and our policies and developer documentation are designed to enable you to provide a fun, safe, and trusted experience for all redditors. We expect you to be honest about your app(s), and to respect the privacy, safety, and other rights of redditors.
 
-You must comply with: these Devvit Rules and Reddit’s [Developer Terms](https://www.redditinc.com/policies/developer-terms), [Developer Data Protection Addendum](https://www.redditinc.com/policies/developer-dpa), and [Data API Terms](https://www.redditinc.com/policies/data-api-terms); our [User Agreement](https://www.redditinc.com/policies/), [Econ Terms](https://www.redditinc.com/policies/econ-terms), [Previews Terms](https://www.redditinc.com/policies/previews-terms), [Privacy Policy](https://www.reddit.com/policies/privacy-policy), [Public Content Policy](https://support.reddithelp.com/hc/en-us/articles/26410290525844-Public-Content-Policy), [Reddit Rules](https://www.redditinc.com/policies/reddit-rules) and [Advertising Policy](https://redditinc.force.com/helpcenter/s/article/Reddit-Advertising-Policy-Restricted-Advertisements); and all other policies and developer documentation governing the use of our developer services (collectively, “**Reddit Terms & Policies**”). We may update Reddit Terms & Policies from time to time, so please check in and review them regularly.
+You must comply with: these Devvit Rules and Reddit’s [Developer Terms](https://www.redditinc.com/policies/developer-terms), [Developer Data Protection Addendum](https://www.redditinc.com/policies/developer-dpa), and [Data API Terms](https://www.redditinc.com/policies/data-api-terms); our [User Agreement](https://www.redditinc.com/policies/), [Econ Terms](https://www.redditinc.com/policies/econ-terms), [Previews Terms](https://www.redditinc.com/policies/previews-terms), [Privacy Policy](https://www.reddit.com/policies/privacy-policy), [Public Content Policy](https://support.reddithelp.com/hc/en-us/articles/26410290525844-Public-Content-Policy), [Reddit Rules](https://www.redditinc.com/policies/reddit-rules) and [Advertising Policy](https://business.reddithelp.com/s/article/Reddit-Advertising-Policy-Overview); and all other policies and developer documentation governing the use of our developer services (collectively, “**Reddit Terms & Policies**”). We may update Reddit Terms & Policies from time to time, so please check in and review them regularly.
 
 ## Reddit app review
 
 Your app is subject to our app review and approval. Reddit may reject or remove any app that violates these Devvit Rules or any other Reddit Terms & Policies at our discretion. We may also suspend or ban accounts tied to developers who violate these Devvit Rules or any other Reddit Terms & Policies.
 
-These Devvit Rules are intended to clarify how we review Devvit apps and streamline the process for you and Reddit. Our goal is to keep redditors safe and enable developers to build fun and useful apps for redditors. This means our Devvit Rules may evolve over time, which you should keep in mind when building or updating your app. Please [reach out](https://developers.reddit.com/docs/help) if you have any questions on these Devvit Rules. Any exceptions to these Devvit Rules or any other Reddit Terms & Policies must be approved in writing by Reddit.
+These Devvit Rules are intended to clarify how we review Devvit apps and streamline the process for you and Reddit. Our goal is to keep redditors safe and enable developers to build fun and useful apps for redditors. This means our Devvit Rules may evolve over time, which you should keep in mind when building or updating your app. Please [reach out](https://developers.reddit.com/docs/guides/faq#help-and-next-steps:~:text=For%20help%20from%20the%20Devvit%20team%20and%20community%3A) if you have any questions on these Devvit Rules. Any exceptions to these Devvit Rules or any other Reddit Terms & Policies must be approved in writing by Reddit.
 
 You can use Devvit and test your app without needing to submit it to Reddit’s App Review. However, to make your app visible in the [Reddit App Directory](https://developers.reddit.com/apps) and publicly available for other mods and admins to install, you’ll need prior app approval. Additionally, if you want to unlock premium features for your app (for example, [payments](./earn-money/payments/payments_overview.md), [fetching](./capabilities/server/http-fetch.mdx), or [using LLMs](#generative-aillm-rules)), you’ll also need prior app approval.
 
@@ -43,7 +43,7 @@ You are required to resubmit your app for Reddit app review every time you publi
 
 We may require you to provide additional information to us in order to complete our app review. We also may periodically or randomly re-review your app and require you to make changes or otherwise face a suspension or ban of your app if we find it to no longer be compliant with these Devvit Rules and Reddit Terms & Policies.
 
-If you have questions about Reddit’s app review and approval process or these Devvit Rules, please reach out for [help](https://developers.reddit.com/docs/help).
+If you have questions about Reddit’s app review and approval process or these Devvit Rules, please reach out for [help](https://developers.reddit.com/docs/guides/faq#help-and-next-steps:~:text=For%20help%20from%20the%20Devvit%20team%20and%20community%3A).
 
 ## General rules
 
@@ -98,7 +98,7 @@ You and your app(s) must not:
 
 ### Don’t build restricted apps
 
-You should not create an app or functionality that promotes or facilitates transactions in a prohibited or regulated industry such as (but not limited to) gambling, healthcare, financial and cryptocurrency products and services, political, alcohol, recreational drugs, or any other restricted category listed in the [Reddit Advertising Policy](https://redditinc.force.com/helpcenter/s/article/Reddit-Advertising-Policy-Restricted-Advertisements).
+You should not create an app or functionality that promotes or facilitates transactions in a prohibited or regulated industry such as (but not limited to) gambling, healthcare, financial and cryptocurrency products and services, political, alcohol, recreational drugs, or any other restricted category listed in the [Reddit Advertising Policy](https://business.reddithelp.com/s/article/Reddit-Advertising-Policy-Overview).
 
 ### No linking out to external apps
 
@@ -160,13 +160,13 @@ Any content used or created by your Devvit app must comply with Reddit Terms & P
 
 - **Using Existing User Content** – your app may copy and display existing Reddit user content and modify it for display, but only in compliance with Reddit’s [Developer Terms](https://www.redditinc.com/policies/developer-terms). User content on Reddit is owned by redditors and not by Reddit, so you must also comply with all requirements or restrictions imposed by the owners of user content. Ask redditors for their permission if you want to use existing user content in ways they might not expect (e.g., by building an in-app pop-up asking for redditor approval).
 
-- **Generating New User Content** – your app may allow new user content to be created by redditors, but all user content must comply with Reddit’s [User Agreement](https://www.redditinc.com/policies/developer-terms), [Reddit Rules](https://www.redditinc.com/policies/reddit-rules), and [Advertising Policy](https://redditinc.force.com/helpcenter/s/article/Reddit-Advertising-Policy-Restricted-Advertisements).
+- **Generating New User Content** – your app may allow new user content to be created by redditors, but all user content must comply with Reddit’s [User Agreement](https://www.redditinc.com/policies/developer-terms), [Reddit Rules](https://www.redditinc.com/policies/reddit-rules), and [Advertising Policy](https://business.reddithelp.com/s/article/Reddit-Advertising-Policy-Overview).
 
   - _Post or Comment Attribution Rules_ – if your app supports the creation of new posts or comments on Reddit by redditors, then you should create a new post or comment with the content author clearly identified as the author of the submitted content. Until your app is approved by Reddit, new content from your app will be posted from your Devvit app account. If your app is approved, then submitPost will post on behalf of the content author.
 
   - _In-App Content Rules_ – if your app allows users to create new forms of user content within your app (for example, a form submission that modifies the content of your app), your app should limit the available forms of expression to prevent potential abuse. Appropriate examples of limited expression include emojis, symbols (e.g., stock tickers), and predefined, safe dictionaries. If you want to minimize the risk of abuse, avoid allowing users to create new in-app content through free-form text inputs in your app.
 
-- **Displaying Devvit App Content** – your app may include information, materials, and other content that you provide and make available through your app. Your app content must also comply with these Devvit Rules, Reddit’s [User Agreement](https://www.redditinc.com/policies/developer-terms), [Reddit Rules](https://www.redditinc.com/policies/reddit-rules), and [Advertising Policy](https://redditinc.force.com/helpcenter/s/article/Reddit-Advertising-Policy-Restricted-Advertisements). You may not use external logos or trademarks in your app without express written permission.
+- **Displaying Devvit App Content** – your app may include information, materials, and other content that you provide and make available through your app. Your app content must also comply with these Devvit Rules, Reddit’s [User Agreement](https://www.redditinc.com/policies/developer-terms), [Reddit Rules](https://www.redditinc.com/policies/reddit-rules), and [Advertising Policy](https://business.reddithelp.com/s/article/Reddit-Advertising-Policy-Overview). You may not use external logos or trademarks in your app without express written permission.
 
 If any content created or otherwise displayed through your app violates these Devvit Rules or other Reddit Terms & Policies, then Reddit may remove the content and/or request you remove the content. Failure to do so can result in your app being removed from Devvit.
 

docusaurus.config.ts

@@ -60,6 +60,7 @@ const config: Config = {
       src: `${baseUrl}events.js`,
     },
   ],
+  clientModules: ["./src/client/openDetailsForHash.ts"],
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.

src/client/openDetailsForHash.ts

@@ -0,0 +1,102 @@
+type HashLocation = {
+  hash: string;
+};
+
+type RouteUpdateArgs = {
+  location: HashLocation;
+};
+
+const headingSelector = "h1, h2, h3, h4, h5, h6";
+
+function getHashId(location: HashLocation): string | null {
+  if (!location.hash) {
+    return null;
+  }
+
+  const hashWithoutPrefix = location.hash.slice(1);
+  const hashBeforeTextFragment = hashWithoutPrefix.split(":~:")[0];
+
+  if (!hashBeforeTextFragment) {
+    return null;
+  }
+
+  try {
+    return decodeURIComponent(hashBeforeTextFragment);
+  } catch {
+    return hashBeforeTextFragment;
+  }
+}
+
+function getTargetElement(id: string): HTMLElement | null {
+  return (
+    document.getElementById(id) ??
+    (document.getElementsByName(id)[0] as HTMLElement | undefined) ??
+    null
+  );
+}
+
+function openAncestorDetails(element: HTMLElement): HTMLDetailsElement | null {
+  const details = element.closest("details");
+
+  if (details instanceof HTMLDetailsElement) {
+    details.open = true;
+    return details;
+  }
+
+  return null;
+}
+
+function openFollowingDetails(element: HTMLElement): HTMLDetailsElement | null {
+  let sibling = element.nextElementSibling;
+
+  while (sibling) {
+    if (sibling instanceof HTMLDetailsElement) {
+      sibling.open = true;
+      return sibling;
+    }
+
+    if (sibling.matches(headingSelector)) {
+      return null;
+    }
+
+    sibling = sibling.nextElementSibling;
+  }
+
+  return null;
+}
+
+function openDetailsForCurrentHash(location: HashLocation = window.location): void {
+  const id = getHashId(location);
+
+  if (!id) {
+    return;
+  }
+
+  const target = getTargetElement(id);
+
+  if (!target) {
+    return;
+  }
+
+  const openedDetails =
+    openAncestorDetails(target) ?? openFollowingDetails(target);
+
+  if (openedDetails) {
+    requestAnimationFrame(() => {
+      target.scrollIntoView({ block: "start" });
+    });
+  }
+}
+
+function scheduleOpenDetails(location: HashLocation = window.location): void {
+  openDetailsForCurrentHash(location);
+  window.setTimeout(() => openDetailsForCurrentHash(location), 100);
+}
+
+if (typeof window !== "undefined") {
+  window.addEventListener("hashchange", () => scheduleOpenDetails());
+}
+
+export function onRouteDidUpdate({ location }: RouteUpdateArgs): void {
+  scheduleOpenDetails(location);
+}