Skip to content

Add domain explanation articles #1765

Open
Pemacaa wants to merge 27 commits intomainfrom
add-domain-explanation-articles
Open

Add domain explanation articles #1765
Pemacaa wants to merge 27 commits intomainfrom
add-domain-explanation-articles

Conversation

@Pemacaa
Copy link
Contributor

@Pemacaa Pemacaa commented Jan 27, 2026

Summary

This PR implements part of the agreed Diátaxis plan for the Domains category, specifically the NEW Explanation articles listed in the "Core Domain Concepts" section.

New Articles

This PR creates 4 new explanation articles and revises 1 existing article:

  1. What Is WHOIS? (revised) - Explains WHOIS protocol and database system
  2. What Is Domain Transfer? - Explains domain transfer concept and process
  3. What Are Domain Contacts? - Explains domain contact types and their roles
  4. What Is Domain Lock? - Explains domain locks and transfer protection
  5. What Is Domain Delegation? - Explains domain delegation and DNS hosting connection

Category Updates

  • Added new "Explanation" section to categories/domains.yaml
  • Created "Core Domain Concepts" subsection
  • All 5 articles organized under Core Domain Concepts

Article Structure

All articles follow strict Diátaxis Explanation mode:

  • Explain concepts, policies, and behavior (not procedures)
  • No step-by-step instructions or UI actions
  • Focus on what the concept is, why it exists, and how it behaves
  • Include cross-links between related explanation articles
  • Link to existing how-to articles where user action is needed

Cross-Links

  • WHOIS ↔ Domain Contacts (bidirectional)
  • Domain Transfer ↔ Domain Lock (bidirectional)
  • Domain Transfer ↔ Domain Contacts (bidirectional)
  • Domain Delegation → relevant how-to articles

Related

  • Part of domains articles revamp (issue #165 in dnsimple-customer-success repo)
  • Follows Diataxis framework (explanation mode)
  • Matches tone and structure of DNS and DNSSEC explanation articles

Checklist

  • All articles follow Diataxis framework (explanation mode)
  • No step-by-step instructions or UI actions
  • Articles include proper frontmatter (title, excerpt, meta)
  • Cross-links between related articles added
  • Category structure updated
  • No linting errors

Pemacaa and others added 3 commits January 21, 2026 17:16
- Create foundational explanation article about WHOIS protocol
- Follows Diataxis framework (explanation mode)
- Part of domains articles revamp (issue #165 in customer-success repo)
- Covers WHOIS purpose, information, privacy, and domain management
This PR implements part of the agreed Diátaxis plan for the Domains category, specifically the NEW Explanation articles listed in the "Core Domain Concepts" section.

New articles:
- What Is WHOIS? (revised)
- What Is Domain Transfer?
- What Are Domain Contacts?
- What Is Domain Lock?
- What Is Domain Delegation?

All articles follow strict Diátaxis Explanation mode:
- Explain concepts, not procedures
- No step-by-step instructions or UI actions
- Focus on what, why, and how concepts behave
- Include cross-links between related articles

Category updates:
- Added Explanation section with Core Domain Concepts subsection
- All 5 articles organized under Core Domain Concepts

Related: Issue #165 in dnsimple-customer-success repo
@Pemacaa Pemacaa self-assigned this Jan 27, 2026
@Pemacaa Pemacaa added the documentation Updates on the documentation and support content. label Jan 27, 2026
@Pemacaa Pemacaa changed the title Add domain explanation articles (Core Domain Concepts) Add domain explanation articles Jan 27, 2026
- Add missing foundational article: What Is a Domain?
- Standardize all explanation article endings with support contact section
- Remove 'Related articles' link lists from all explanation articles
- Add 'What Is a Domain?' to categories/domains.yaml at top of Core Domain Concepts

All 6 articles now follow strict Diátaxis Explanation mode:
- Explain concepts only, no procedures
- No step-by-step instructions or UI actions
- Standardized ending with support contact information
- No Table of Contents

Articles included:
- What Is a Domain? (new)
- What Is WHOIS? (revised ending)
- What Is Domain Transfer? (revised ending)
- What Are Domain Contacts? (revised ending)
- What Is Domain Lock? (revised ending)
- What Is Domain Delegation? (revised ending)
@Pemacaa Pemacaa requested a review from stephanoodle February 4, 2026 15:32
- Replace smart quotes (curly apostrophes) with straight apostrophes
- Fix double parenthesis in Domain Name System link
- Update lib/sub_categories.rb to handle nested category structures
- Update layouts/category_index.html to render nested sections
- Matches changes from main branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Updates on the documentation and support content.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants