Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
OliviaGalaxy3DVision committed Nov 30, 2023
1 parent b1e5e2c commit d95a743
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 8 deletions.
49 changes: 49 additions & 0 deletions frontend/Doc/community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# XLang Community Guidelines

Welcome to the XLang Community! As a collaborative and open-source project focused on the development and enhancement of the XLang programming language, we are dedicated to creating an inclusive, innovative, and supportive environment. This document provides guidelines and information on how you can get involved, contribute, and be a part of our growing community.

## 1. Introduction to XLang

XLang is a dynamic, high-performance programming language specifically designed for AI and IoT applications. It features natural-born distributed computing capabilities, seamless integration with languages like C++, Python, and JavaScript, and is optimized for tensor computing and neural network building.

## 2. Our Community Values

- **Inclusivity and Respect:** We welcome contributors from all backgrounds and skill levels. Respectful communication and collaboration are key.
- **Openness and Transparency:** We believe in open-source principles, ensuring our work is transparent and accessible to everyone.
- **Innovation and Excellence:** We strive for continuous improvement and innovation in everything we do.

## 3. Getting Involved

- **Join the Conversation:** Participate in community discussions on our forums, mailing lists, or chat channels.
- **Contribute to the Codebase:** Fork our GitHub repository, make changes, and submit pull requests.
- **Report Issues and Request Features:** Use our issue tracker to report bugs and suggest enhancements.
- **Improve Documentation:** Help new users by improving our documentation, tutorials, and guides.

## 4. Contribution Guidelines

- **Code of Conduct:** Adhere to our code of conduct, which promotes a respectful and harassment-free experience for everyone.
- **Best Practices:** Follow coding standards and best practices for development, testing, and documentation.
- **Peer Review:** Contributions are peer-reviewed by community members to ensure quality and alignment with project goals.

## 5. Community Resources

- **Documentation:** Access comprehensive documentation for getting started, API references, and development guides.
- **Tutorials:** Learn through step-by-step tutorials ranging from basic to advanced topics.
- **Community Support:** Get support and answers from the community through our various support channels.

## 6. Events and Meetups

- **Conferences:** Join us at conferences and meetups to learn about the latest developments and network with community members.
- **Hackathons and Competitions:** Participate in hackathons and coding competitions to showcase your skills and contribute to interesting projects.

## 7. Stay Connected

- **Newsletter:** Subscribe to our newsletter for the latest news, updates, and event information.
- **Social Media:** Follow us on social media platforms for regular updates and community highlights.

## 8. Leadership and Governance

- **Community Leaders:** Our community is guided by experienced leaders who are committed to the growth and success of XLang.
- **Contribution Recognition:** We acknowledge and appreciate the efforts of our contributors at all levels.

Thank you for being a part of the XLang Community! Together, we are building a powerful tool for AI and IoT applications, pushing the boundaries of what's possible in programming languages. Your contributions, big or small, make a significant difference.
8 changes: 6 additions & 2 deletions frontend/community.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@

<body>

<md-block style="width:100%;height:100%;margin-left:20px;margin-right:20px;" src="/tutorials/overview.md">
<div style="width:90%;height:100%; margin-left:5%; overflow:auto;">

</md-block>
<md-block id="idContent" style="width: 100%; padding-left: 20px; padding-right: 20px; border-left: groove; overflow: scroll;" src="/Doc/introduce.md">

</md-block>

</div>
</body>
</html>
7 changes: 1 addition & 6 deletions frontend/documentation.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<script>
function go_to(url) {
$('#idContent').set('src', url);
}
</script>
<script type="module" src="scripts/md_block.js"></script>
</head>
<body>
<div style="width:100%;height:100%;overflow:auto;">
<div style="width:90%;height:100%; margin-left:5%; overflow:auto;">

<md-block id="idContent" style="width: 100%; padding-left: 20px; padding-right: 20px; border-left: groove; overflow: scroll;" src="/Doc/introduce.md">

Expand Down

0 comments on commit d95a743

Please sign in to comment.