Skip to content

Latest commit

 

History

History

home

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

Foxe Labs Docs — Landing Page

The page served at the root of docs.foxelabs.com. Its only job is to offer the two tracks and send visitors into one of them.

This is one of three VitePress sites in this repo; see the root README for the overall setup.

Why it is a VitePress site

A hand-written index.html would have been simpler, but it would need its own styling and would drift from the docs' look, including light and dark themes. Building it with VitePress means it picks up the shared header, nav, social icons and footer from shared/theme.mjs for free.

It has no sidebar and no search — there is only one page.

What to edit

Everything lives in index.md: the hero copy and the two cards. The cards link to each track's intro page, not to a section root, since neither track has a home page of its own:

Card Links to
Software https://docs.foxelabs.com/software/get-started
Trading https://docs.foxelabs.com/trading/get-started

Those have to be absolute URLs with target: _self, not root-relative paths. Each of the three sites is a separate VitePress build with its own client-side router, so a link to /software/get-started would be resolved as a route within this site and render a 404 — while a hard refresh would work, since that reaches the server instead. The same constraint applies to the cross-site nav links in shared/theme.mjs.

If either intro page is ever renamed, update the card here, the nav in shared/theme.mjs, and the redirect in vercel.json — all three point at it.

Working on it

From the repo root:

npm run dev:home

Build just this site with npm run build:home. Unlike the other two, it builds to its own .vitepress/dist and is then copied into dist/ by the copy:home script. Writing straight to dist/ would let Vite empty the directory and take the sibling software/ and trading/ output with it.

License

Licensed under the GPL-2.0-or-later.