devloperdevesh / devloperdevesh/FaultPlane
[Documentation] Complete the LaTeX/Markdown formatting for Enterprise Use Cases
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2
- Forks
- 1
- Avg merge
- 14m
- Merged PRs (30d)
- 57
Description
We have drafted our core enterprise infrastructure specification whitepapers inside the docs/architecture/ tree mapping how Fortune 500 clusters deploy FaultPlane to stop GPU compute drops.
We need a contributor to audit the formatting across ENTERPRISE_USE_CASES.md and ensure the multi-tenant memory fencing ASCII topology graphs align correctly with Markdown and IEEE spec criteria.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/architecture/ENTERPRISE_USE_CASES.md and audit its LaTeX/Markdown formatting, especially the multi-tenant memory fencing ASCII topology graphs. Check the document against the stated IEEE formatting criteria and ensure the graphs align correctly in rendered Markdown. Done means the whitepaper formatting is consistent and the topology diagrams remain readable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- latex, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100