mirror of
https://github.com/Xahau/xahau-web.git
synced 2025-11-04 12:15:49 +00:00
c25e8f7c57
* Remove extra section from Infrastructure sidebar in the documentation. Also remove cabbit.tech hubs. * Expand details on running a mainnet node. * Combine mainnet and testnet node install instructions to a single page. * Update system requirements. * Edit system requirements again. * Add placeholders for new documentation and contributing guidelines. * Update header, footer, and IndexLayout links to reflect renaming the infrastructure page to 'system-requirements'. * Fix overwrite from upstream index page layout. Add intro paragraph to running xahaud page. * Describe different types of nodes, expand contributing.md * Minor editing and revisions. * Additional guidelines added. * Add a placeholder page for 'Updating xahaud'. * Edited install/system requirements/updating. * Add instructions for updating Docker containers. * Add updating local install instructions. * Add background on enabling validation. * Add instructions on running xahaud as a validator. * Minor revisions to enabling validations and interacting with xahaud * Fixed minor typos and added formatting to the interacting.mdx webpage. * Add master example xahaud.cfg file to table on install page.
1.8 KiB
1.8 KiB
Intro
Public contributions to the documentation are welcome. When contributing, please help with consistency and clarity by adhering to the below guidelines.
Disambiguation
- Strive for brevity and clarity. Avoid jargon and use a professional writing tone.
- When referring to the software
xahaud, use a lowercase "x" and include the 'd'. When referring to the broaderXahau Network, capitalize both terms and,if appropriate, subsequently use the capitalized term "the Network". Use the capitalizedXahauor the all caps abbreviationXAHwhen referring to the currency. - Be mindful that this documentation is shared by a global community. Avoid culture-specific jargon or slang.
Formatting
- Relative and absolute linking are both permitted. When changing the directory structure or renaming individual pages, use grep to ensure all links are updated. Header, footer, index page, navigation bar, and links on other pages all need to be updated manually.
- The use of second person ("you") is permitted.
- Individual webpages may be formatted using Markdown, HTML, CSS, and JavaScript in any combination. To the extent possible, favor style templates and avoid inline CSS.
- When using bulleted or numbered lists end sentences with a period ('.'), unless doing so interferes with content. For example, if a bulleted list item ends with a link to a webpage, do not add a '.' at the end of the link, as doing so breaks the link. Similarly, do not add a '.' after code snippets.
- Capitalize proper nouns, including "Testnet" and "Mainnet". Prefer single word for these terms.
- Use square brackets inside code snippets to offset user specific information, such as file names and paths. For example:
cd [/path/to/xahaud] && ./xahaud server_info - Wrap multi-line code examples in three backticks: "```".
General Guidelines
- Include meaningful commit messages.