Aller au contenu principal

Welcome to PolyDocs Documentation

About This Documentation​

PolyDocs is a collaborative effort to document and organize educational resources at Polytechnique Montreal. This documentation section is designed to be a resource hub for students, with course notes, tutorials, and guides across a variety of subjects.

Contributing to the Documentation​

We welcome contributions from everyone! Here are some specific guidelines to help you get started:

  • Organizing Content: Place content in the appropriate folder based on type (e.g., tutorials, notes, or translations).
  • Review Process: Contributions will be reviewed to ensure quality and consistency.

Suggested Topics and Content Roadmap​

Here are some areas where contributions are especially welcome:

  • New Course Notes: We’re currently missing notes for most Poly courses!
  • Translations: We need translations for several sections to make PolyDocs accessible to more students.
  • Tutorials and Guides: If you have expertise in a topic, consider writing a tutorial to help others learn.

Style Guide​

To maintain consistency across our documentation, please follow these guidelines:

  • Use a friendly, clear tone: Aim to make content easy to understand.
  • Be consistent with terminology: Use consistent terminology, such as “assignment” instead of “homework.”
  • Include examples where possible: Illustrations and examples help readers understand complex topics.

Frequently Asked Questions​

How do I find content related to a specific course?​

Use the sidebar to navigate by course code, or use the search functionality to find specific topics.

Can I contribute notes or tutorials for a course that isn’t listed?​

Absolutely! If you don’t see a course, feel free to add it following a similar structure to the others!

How do I suggest a new feature or improvement?​

If you have an idea for a new feature or improvement, please open an issue on the Github repo. Or better yet, submit a pull request with the feature!

How do I report an issue or error?​

If you find an issue or error in the documentation, please open an issue on the Github repo. Or better yet, submit a pull request with the fix!

How do I get help with contributing?​

If you have questions about contributing, please reach out to the PolyDocs team or open an issue on the Github repo.

Acknowledgments​

Thank you to all contributors who have helped build this resource! Your efforts make a meaningful difference for students at Polytechnique Montreal.

Contact Us​

If you have questions or feedback, please reach out to the PolyDocs team at polykarma.channel@gmail.com

By making your first contribution, you’re joining a community of learners dedicated to sharing knowledge. Thank you for helping to grow PolyDocs!