Skip to content

docs(docsite): add Docusaurus-based docsite with .md imports#6

Merged
DeepanshKhurana merged 1 commit into
mainfrom
docs/integrate-docusaurus
Dec 27, 2025
Merged

docs(docsite): add Docusaurus-based docsite with .md imports#6
DeepanshKhurana merged 1 commit into
mainfrom
docs/integrate-docusaurus

Conversation

@DeepanshKhurana
Copy link
Copy Markdown
Member

Related Issue:
Fixes #5

Description of Changes:
Implemented a programmatic import system to live-link root markdown files (README.md, ETHOS.md, etc.) to the documentation. Added automatic transformation for GitHub-style alerts, image paths, and internal links. The reasoning for this approach is that a lot of people may want to find the documentation on GitHub itself. This way, there is always going to be a single source of truth. There is also an indexed local search so the main purpose is achieved.

Additional Notes

  • The documentation is styled the site to match the Ode's default journal theme.
  • The size of this change is large because of Docusaurus' dependencies.

@DeepanshKhurana DeepanshKhurana self-assigned this Dec 27, 2025
@vercel
Copy link
Copy Markdown

vercel Bot commented Dec 27, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
ode-demo Ready Ready Preview, Comment Dec 27, 2025 1:18pm

@DeepanshKhurana DeepanshKhurana merged commit fa779b7 into main Dec 27, 2025
2 checks passed
@DeepanshKhurana DeepanshKhurana deleted the docs/integrate-docusaurus branch December 27, 2025 13:18
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.

[REQUEST] Deployed Documentation

1 participant