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

DOP-5205: Improve onboarding docs #634

Merged
merged 7 commits into from
Nov 19, 2024
Merged

DOP-5205: Improve onboarding docs #634

merged 7 commits into from
Nov 19, 2024

Conversation

i80and
Copy link
Contributor

@i80and i80and commented Nov 19, 2024

Ticket

DOP-5205

Notes

README updates

    • This PR introduces changes that should be reflected in the README.md and/or HACKING.md, and I have made those updates.
    • This PR does not introduce changes that should be reflected in the README.md and/or HACKING.md

Copy link
Collaborator

@seungpark seungpark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

beautiful! thank you for doing this! the diagram being included should help draw a mental image <3

HACKING.md Show resolved Hide resolved
HACKING.md Outdated
<dd>The primary entry point of the docs' original tech stack: it would download assets, generate reStructuredText from YAML files (hence the `gizaparser/` directory for compatibility), and invoke Sphinx.</dd>

<dt>Sphinx</dt>
<dd>The primary unofficially official documentation toolchain for reStructuredText.</dd>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😂

HACKING.md Show resolved Hide resolved
HACKING.md Show resolved Hide resolved
HACKING.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@rayangler rayangler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice changes!

@i80and i80and merged commit 84fe7c5 into mongodb:main Nov 19, 2024
5 checks passed
@i80and i80and deleted the DOP-5205 branch November 19, 2024 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants