Documentation
: Convert docs to markdown and improve readme
#244
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
andREADME.md
files, updates to the Sphinx documentation configuration, and minor adjustments to theMakefile
.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 themyst_parser
extension, and excludedREADME.md
from the build process. [1] [2]Other changes:
docs/Makefile
: Modified the--watch
option to watch the entire directory instead of just thesource
directory.docs/admin/production_setup.md
: Added a placeholder for production setup instructions.