Contributing

RunEntLinux is a documentation project. This page describes how to report problems and the writing conventions.

Ways to Contribute

Report Issues

If you find content errors, outdated commands, or inaccurate descriptions, please report it to the site maintainers, with the page address, system version and observed output (remove credentials and private information).

Add Content

Content is maintained by the site maintainers. When adding tutorials or improving existing content:

1. Follow the conventions in WRITING_GUIDE.md; new pages must be provided in both Chinese and English
2. Register the new page in the sidebar section of astro.config.mjs
3. State what changed and which official sources it relies on

Writing Guidelines

File Format

• Use .md for plain text tutorials; use .mdx when component interaction is needed
• Use English kebab-case for file names: dnf-basics.mdx
• Every file must have title and description frontmatter

Command Examples

• $ prefix indicates a regular user; # indicates root
• Prefer using sudo over switching to root
• Add a title to each code block explaining its purpose
• Note the applicable distribution and version

Style

• Address the reader as “you”
• Keep paragraphs short — no more than 5 lines each
• Avoid using two admonitions in a row
• Use consistent terminology: DNF, SELinux, systemd, firewalld, NetworkManager

Content Structure

Recommended structure for tutorial pages:

1. One-sentence introduction
2. “What you will learn” list
3. Prerequisites
4. Step-by-step body
5. Common questions
6. Further reading

For detailed guidelines, see WRITING_GUIDE.md in the project.

Local Development

Install dependencies and start dev server

$ npm install
$ npm run dev

Visit http://localhost:4321/ in your browser to preview.

Build for production

$ npm run build