Skip to main content

RFC 2865 Formatting Guide

Overview​

This guide helps format RFC 2865 (RADIUS) into Docusaurus MDX files.

File Structure (76 files total)​

Core Sections​

  • index.md - Main index (✅ Complete)
  • 1-introduction.md - Introduction
  • 1-1-specification-of-requirements.md
  • 1-2-terminology.md

Operation (7 files)​

  • 2-operation.md
  • 2-1-challenge-response.md
  • 2-2-interoperation-with-pap-and-chap.md
  • 2-3-proxy.md
  • 2-4-why-udp.md
  • 2-5-retransmission-hints.md
  • 2-6-keep-alives-considered-harmful.md

Packet Format & Types (6 files)​

  • 3-packet-format.md
  • 4-packet-types.md
  • 4-1-access-request.md
  • 4-2-access-accept.md
  • 4-3-access-reject.md
  • 4-4-access-challenge.md

Attributes (45 files)​

  • 5-attributes.md - Main attributes section
  • 5-1-user-name.md through 5-44-table-of-attributes.md

Closing Sections (9 files)​

  • 6-iana-considerations.md
  • 6-1-definition-of-terms.md
  • 6-2-recommended-registration-policies.md
  • 7-examples.md
  • 7-1-user-telnet-to-specified-host.md
  • 7-2-framed-user-authenticating-with-chap.md
  • 7-3-user-with-challenge-response-card.md
  • 8-security-considerations.md
  • 9-change-log.md
  • 10-references.md
  • 11-acknowledgements.md
  • 12-chairs-address.md
  • 13-authors-addresses.md
  • 14-full-copyright-statement.md

Front Matter Template​

---
id: chapter-id
title: Full Chapter Title
sidebar_label: Short Title
sidebar_position: N
---

Content Formatting Rules​

1. Remove Pagination​

// Remove these patterns:
Rigney, et al.              Standards Track                     [Page N]
RFC 2865                         RADIUS                        June 2000

2. MDX Safety​

  • Escape < as &lt; (except in code blocks)
  • Escape { as \{
  • Escape } as \}
  • Wrap URLs: `https://example.com`

3. Format Tables​

Convert ASCII art tables to Markdown:

| Column 1 | Column 2 |
|----------|----------|
| Value 1  | Value 2  |

4. Code Blocks​

```text
Code or diagram content here

## Quality Checklist

- [ ] All 76 files created
- [ ] Front Matter correct in each file
- [ ] Page numbers removed
- [ ] Headers/footers removed
- [ ] MDX special characters escaped
- [ ] URLs wrapped in backticks
- [ ] Tables formatted properly
- [ ] Code blocks marked correctly
- [ ] Links between files work
- [ ] Sidebar navigation correct

## Processing Approach

1. **Extract by section** from source RFC
2. **Add Front Matter** with correct position
3. **Clean content** (remove pagination)
4. **Ensure MDX safety** (escape chars)
5. **Format diagrams** and tables
6. **Validate** all links and references

## Legal Notice

RFC documents are published by IETF under terms allowing format conversion for educational purposes. See RFC 5378 and IETF Trust Legal Provisions.

Source: `https://www.rfc-editor.org/rfc/rfc2865.txt`
Last updated on