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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] moved doc test command to bottom #3075

Merged
merged 1 commit into from
Mar 9, 2023

Conversation

FrankLeeeee
Copy link
Contributor

馃搶 Checklist before creating the PR

  • I have created an issue for this PR for traceability
  • The title follows the standard format: [doc/gemini/tensor/...]: A concise description
  • I have added relevant tags if possible for us to better distinguish different PRs

馃毃 Issue number

Link this PR to your issue with words like fixed to automatically close the linked issue upon merge

e.g. fixed #1234, closed #1234, resolved #1234

Fixed #3074

馃摑 What does this PR do?

Summarize your work here.
if you have any plots/diagrams/screenshots/tables, please attach them here.

This PR fixed the documentation sidebar name. The root cause is that Docusaurus takes the first line of the markdown file as the sidebar title. Therefore, we need to move doc-test-command declaration to the bottom of the file instead.

馃挜 Checklist before requesting a review

  • I have linked my PR to an issue (instruction)
  • My issue clearly describes the problem/feature/proposal, with diagrams/charts/table/code if possible
  • I have performed a self-review of my code
  • I have added thorough tests.
  • I have added docstrings for all the functions/methods I implemented

猸愶笍 Do you enjoy contributing to Colossal-AI?

  • 馃対 Yes, I do.
  • 馃寶 No, I don't.

Tell us more if you don't enjoy contributing to Colossal-AI.

@FrankLeeeee FrankLeeeee self-assigned this Mar 9, 2023
@FrankLeeeee FrankLeeeee added bug Something isn't working documentation Improvements or additions to documentation labels Mar 9, 2023
@FrankLeeeee FrankLeeeee merged commit 416a50d into hpcaitech:main Mar 9, 2023
@FrankLeeeee FrankLeeeee deleted the hotfix/doc-test-cmd-pos branch March 9, 2023 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG]: The documentation name is not correctly displayed
2 participants