Skip to content

[doc] added docusaurus-based version control#2656

Merged
FrankLeeeee merged 1 commit intohpcaitech:mainfrom
FrankLeeeee:feature/docusaurus
Feb 9, 2023
Merged

[doc] added docusaurus-based version control#2656
FrankLeeeee merged 1 commit intohpcaitech:mainfrom
FrankLeeeee:feature/docusaurus

Conversation

@FrankLeeeee
Copy link
Copy Markdown
Contributor

@FrankLeeeee FrankLeeeee commented Feb 9, 2023

📌 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 #2655

📝 What does this PR do?

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

This PR added docusaurus files to control the website behaviour and versions.

  • sidebars.js: this is a file for the sidebar for each version.
  • version.js: the website will only render documents for versions included in this file in the main branch. That means you can control the versions shown on the website in the main branch without a release.

💥 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 added the documentation Improvements or additions to documentation label Feb 9, 2023
@FrankLeeeee FrankLeeeee merged commit a4ae43f into hpcaitech:main Feb 9, 2023
@FrankLeeeee FrankLeeeee deleted the feature/docusaurus branch February 9, 2023 08:38
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.

[DOC]: Integrate Docusaurus for version control

2 participants