Why thic change?

Oopsie doopsie

fixed

Perhaps it would make sense to create a directory that is more obvious for auto generated files. Such as "guides/generated/...". Then you can also add the whole directory to the .gitignore instead of individual files.

That sounds like a good idea will do

One downside of this is that the slug shown in the browser becomes http://localhost:4321/generated/governance/ instead of http://localhost:4321/general/governance/.

From a users perspective I feel like governance being under general makes more sense but programmatically http://localhost:4321/generated/governance/ is ofc also correct

I don't think that using sed in a Makefile is the best option to include the files here. A preferrable way would be to do the manipulation right in the respective .mdx files, as Astro seems to have an embedded JavaScript scripting interface that allows you to manipulate the included files:

https://docs.astro.build/en/guides/markdown-content/#dynamic-jsx-like-expressions

I was simply following the way it was done in the doxygen Makefile, technically it should be possible in javascript but the complexity outweighs the usage since we would have to create our own content collection which really isnt worth it for this scenario

I'm a lazy maintainer and asked ChatGPT:

---
title: Governance
description: This document outlines the governance structure of RIOT.
import fs from 'node:fs'
import path from 'node:path'

/* read external Markdown file */
const markdownPath = path.resolve('../../GOVERNANCE.md');
let content = fs.readFileSync(markdownPath, 'utf-8');

/* remove the TOC block */
content = content.replace(/<!-- TOC start -->[\s\S]*?<!-- TOC end -->/, '');
---

import { Markdown } from 'astro/components';

<Markdown content={content} />

Doesn't look terribly compilcated but I didn't check whether it works or not. But hey, when was the last time AI didn't propose a working solution? 🤣

Oh you wanted to do it like this, hmmm, I personally really dont like that approach because Id also cause the document to be garbage when reading on github while the current approach would have simply not shown the document on github, if anything I'd have gone with https://docs.astro.build/en/guides/content-collections/ (which is what I was referring to in my comment as too complicated for 2 files)

However, I don't have high stakes in this, I'm alright with replacing the makefile command with this if this is the preferred solution 🫡

Long lines :)

The length of my ancestors (30 year olds) lines weighs on me 😔 Will fix

I trimmed the hedge