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.

Sign up for GitHub

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

Jump to bottom

Developer Docs deployment #4740

Open

junminahn opened this issue Jan 23, 2025 · 0 comments

Assignees

Collaborator

junminahn commented Jan 23, 2025 •

edited

Loading

Description

To enhance knowledge sharing among developers, we aim to deploy a web-based platform that renders markdown files committed to the repository.

Technical Details

MkDocs (https://www.mkdocs.org/) has been identified as the tool for this purpose.
Set up a continuous deployment (CD) pipeline to publish MkDocs to the GitHub Pages of the repository.
Use the main README.md and the files in the docs directory as the initial content for the site.

Definition of Done (DOD)

Changes to README.md or files in the docs directory automatically update the site.

The text was updated successfully, but these errors were encountered:

junminahn self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment