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

Adding back SUMMARY.md file #520

Merged
merged 2 commits into from
Jan 23, 2024
Merged

Adding back SUMMARY.md file #520

merged 2 commits into from
Jan 23, 2024

Conversation

eric-lidong
Copy link
Contributor

Description

In the recent PR to Merlin, the SUMMARY.md file is removed from the docs. While it does not affect the overall CaraML docs on gitbook, this Merlin specific MD file was added to make sure Merlin docs can work standalone with gitbook, similar to how Turing and Turing XP docs are gitbook compatible. e.g. Users who uses Merlin/Turing/Turing XP alone, outside of the CaraML setting, can also use gitbook to refer to the docs.

Modifications

Adding back the SUMMARY.md file and updated to conform with the new document structure.

Tests

Checklist

  • Added PR label
  • Added unit test, integration, and/or e2e tests
  • Tested locally
  • Updated documentation
  • Update Swagger spec if the PR introduce API changes
  • Regenerated Golang and Python client if the PR introduces API changes

Release Notes


@eric-lidong eric-lidong added the documentation Improvements or additions to documentation label Jan 22, 2024
Copy link
Contributor

@leonlnj leonlnj left a comment

Choose a reason for hiding this comment

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

thanks lgtm

@leonlnj
Copy link
Contributor

leonlnj commented Jan 23, 2024

I think you can ignore the errors, AFAIK merlin ci cant run from forked repo, the dev usually create a branch from the main repo

@eric-lidong eric-lidong merged commit 52dc4ec into caraml-dev:main Jan 23, 2024
23 of 25 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants