Modifying documentation website

First, important links:

Documentation website repository: https://github.com/Zakros-InterArts/Telematic-Theater-Documentation

Documentation website: https://tt-docs-zakros.vercel.app/ (temporary URL)

Documentation website CMS (for editing content): https://tt-docs-zakros.vercel.app/tt-cms/ (temporary URL)

Starlight documentation (what our documentation website is built with: will give you guidelines to customize some parts of it, how its builtin css is structured...): https://starlight.astro.build/getting-started/

Then, content of the repository (excerpt):

doc: folder containing the textual content of the documentation website. This is what is accessible and can be edited through the CMS
public: this folder gets copied as-is in the server
- media: images and video content of the documentation. This is also visible and can be edited from the CMS
- tt-cms: where the CMS lives. If modifications to the CMS pages looks/feels have to be done, it is on files in that folder
src: contains source files of the documentation website. This is where are the files to be edited to change the documentation website look/feel
- components
- pages
- styles
  - custom.css contain css that gets applied on top of Starlight theme. This is where you want to add new rules and override existing ones.
  - filetree.css
- content.config.ts
astro.config.mjs: configuration instructions for Astro to build the website. This is where additional info might be added to build/copy more files, like the ones in src/styles, or some additional javascript if required.

A quick guideline would be:

Clone the repository (first link) on your computer
Open an LLM agent in the repository folder and work with it
To delete previously cached files and run a new build: rm -rf node_modules/.astro .astro dist; bun run dev
You can then access the local website with your changes at http://localhost:4321/
Once you're happy with the result, commit and push to the main branch. Vercel should automatically trigger a new build of the website, which new version should be online at tt-docs-zakros.vercel.app after a few minutes

Modifying documentation website

First, important links:

Documentation website repository: https://github.com/Zakros-InterArts/Telematic-Theater-Documentation

Documentation website: https://tt-docs-zakros.vercel.app/ (temporary URL)

Documentation website CMS (for editing content): https://tt-docs-zakros.vercel.app/tt-cms/ (temporary URL)

Then, content of the repository (excerpt):

doc: folder containing the textual content of the documentation website. This is what is accessible and can be edited through the CMS
public: this folder gets copied as-is in the server
- media: images and video content of the documentation. This is also visible and can be edited from the CMS
- tt-cms: where the CMS lives. If modifications to the CMS pages looks/feels have to be done, it is on files in that folder
src: contains source files of the documentation website. This is where are the files to be edited to change the documentation website look/feel
- components
- pages
- styles
  - custom.css contain css that gets applied on top of Starlight theme. This is where you want to add new rules and override existing ones.
  - filetree.css
- content.config.ts
astro.config.mjs: configuration instructions for Astro to build the website. This is where additional info might be added to build/copy more files, like the ones in src/styles, or some additional javascript if required.

A quick guideline would be:

Clone the repository (first link) on your computer
Open an LLM agent in the repository folder and work with it
To delete previously cached files and run a new build: rm -rf node_modules/.astro .astro dist; bun run dev
You can then access the local website with your changes at http://localhost:4321/
Once you're happy with the result, commit and push to the main branch. Vercel should automatically trigger a new build of the website, which new version should be online at tt-docs-zakros.vercel.app after a few minutes

Modifying documentation website

Comments

Modifying documentation website

Comments