mirror of
https://github.com/varun-r-mallya/Python-BPF.git
synced 2026-02-07 13:40:59 +00:00
docs: remove unnecessary fluff from README
This commit is contained in:
@ -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).
|
||||
|
||||
Reference in New Issue
Block a user