Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Convert docs to markdown and improve readme #244

Merged
merged 6 commits into from
Feb 5, 2025

Conversation

FelixTJDietrich
Copy link
Collaborator

This pull request includes several updates to documentation and configuration files to improve clarity, transparency, and functionality. Key changes include enhancements to the CONTRIBUTING.md and README.md files, updates to the Sphinx documentation configuration, and minor adjustments to the Makefile.

Documentation updates:

  • CONTRIBUTING.md: Added detailed contribution guidelines for both members of the organization and external contributors, emphasizing the importance of using real names and authentic profile pictures.
  • README.md: Revised the project description to better reflect the mission and main features of Hephaestus, and added a new roadmap section outlining short-term, medium-term, and long-term goals.

Sphinx documentation configuration:

  • docs/conf.py: Updated project metadata, added support for Markdown files with the myst_parser extension, and excluded README.md from the build process. [1] [2]

Other changes:

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 5, 2025
@github-actions github-actions bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label Feb 5, 2025
@FelixTJDietrich FelixTJDietrich merged commit aa0d058 into develop Feb 5, 2025
12 checks passed
@FelixTJDietrich FelixTJDietrich deleted the docs/convert-to-markdown branch February 5, 2025 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant