varun-r-mallya/python-bpf
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/Python-BPF.git synced 2026-02-07 21:50:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove unnecessary fluff from README

Browse Source
This commit is contained in:
Pragyansh Chaturvedi
2026-01-22 03:30:56 +05:30
parent b6d8b71308
commit c1f32a2839
1 changed files with 0 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/README.md
View File

@ -42,25 +42,3 @@ make clean # Clean build artifacts
## Writing Documentation ## Writing Documentation
Documentation is written in Markdown using [MyST-Parser](https://myst-parser.readthedocs.io/). See the existing files for examples. 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).