From c1f32a2839816889f64d93b7572a63ca91875e0e Mon Sep 17 00:00:00 2001 From: Pragyansh Chaturvedi Date: Thu, 22 Jan 2026 03:30:56 +0530 Subject: [PATCH] docs: remove unnecessary fluff from README --- docs/README.md | 22 ---------------------- 1 file changed, 22 deletions(-) diff --git a/docs/README.md b/docs/README.md index b43e609..dda335b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -42,25 +42,3 @@ make clean # Clean build artifacts ## Writing Documentation Documentation is written in Markdown using [MyST-Parser](https://myst-parser.readthedocs.io/). See the existing files for examples. - -### MyST Markdown Features - -- Standard Markdown syntax -- Directives using `{directive}` syntax -- Cross-references using `{doc}` and `{ref}` -- Admonitions (notes, warnings, tips) -- Code blocks with syntax highlighting - -## Contributing - -When adding new documentation: - -1. Follow the existing structure -2. Use MyST Markdown syntax -3. Include code examples -4. Test the build with `make html` -5. Check for warnings and errors - -## Online Documentation - -The documentation is automatically built and deployed to GitHub Pages (if configured).