Skip to content

New docs for subdomain configuration #699

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

hahnbeelee
Copy link
Member

@hahnbeelee hahnbeelee commented May 13, 2025

Things to note about this:
UX-wise - everything will need to be nested within the repo. This might be a less favorable UX, but this allows our users to have any sort of custom directory and can be deeply nested like /custom/directory.

To-Do

  • Update Cloudflare docs
  • Update AWS docs

the main blocker here is that I need to figure out how to do it on these platforms.

following configuration to your `vercel.json` file.
<Steps>
<Step title="Move your docs files">
Edit your file structure so that all your files are within a folder which is your custom subpath. So if you want to host your docs at `/docs` you would do the following:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Edit your file structure so that all your files are within a folder which is your custom subpath. So if you want to host your docs at `/docs` you would do the following:
Create a folder with the same name as your custom subpath and add all your documentation files to the folder. If you want to host your docs at `/docs`, you would do the following:

I want to make it clear to people what files they need to add to the directory since it looks like docs.json should remain outside the subpath directory. Please let me know if this isn't accurate though. Goal is that people quickly know what to organize into their subpath folder.

```
</Step>
<Step title="Configure your vercel.json">
In your main website add the following rewrites to your `vercel.json`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In your main website add the following rewrites to your `vercel.json`.
In your main website add the following rewrites to your `vercel.json` file.

This is tiny, but the sentence feels incomplete as is.

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