[docs] Fix links, little style tweaks (#2724)

This PR is a small but mighty improvement to our docs.

### Change Type

- [ ] `patch` — Bug fix
- [ ] `minor` — New feature
- [ ] `major` — Breaking change
- [ ] `dependencies` — Changes to package dependencies[^1]
- [x] `documentation` — Changes to the documentation only[^2]
- [ ] `tests` — Changes to any test code only[^2]
- [ ] `internal` — Any other changes that don't affect the published
package[^2]
- [ ] I don't know

[^1]: publishes a `patch` release, for devDependencies use `internal`
[^2]: will not publish a new version

---------

Co-authored-by: Mime Čuvalo <mimecuvalo@gmail.com>

apps/docs/scripts/functions/generateSection.ts

@@ -119,6 +119,13 @@ export function generateSection(section: InputSection, articles: Articles, index
 						: `/${section.id}/${categoryId}/${articleId}`,
 		}
 
+		if (isExamples) {
+			// split content above the first ---
+			const splitUp = parsed.content.split('---\n')
+			article.description = splitUp[0]
+			article.content = splitUp.slice(1).join('---\n')
+		}
+
 		if (isIndex) {
 			article.categoryIndex = -1
 			article.sectionIndex = -1