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

Update docusaurus.config.js with corrected projectName and GitHub link #1210

Merged
merged 1 commit into from
May 9, 2024

Conversation

kevin-lee
Copy link
Contributor

Update docusaurus.config.js with corrected projectName and GitHub link

  • The documentation site is for sbt, so the projectName should be sbt, not website.
  • The GitHub link should direct to the sbt repository rather than the website repository, as the doc site itself is for sbt.

This is what I think it should be, but I don't know the intention of the current config, so this PR might make no sense.

… link:

- The documentation site is for `sbt`, so the `projectName` should be `sbt`, not `website`.
- The GitHub link should direct to the `sbt` repository rather than the `website` repository, as the doc site itself is for sbt.
Copy link
Member

@eed3si9n eed3si9n left a comment

Choose a reason for hiding this comment

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

Thanks!
I guess having a separate repo is not the usual setup for Docusaurus?

@eed3si9n eed3si9n merged commit 0a37dcf into sbt:develop May 9, 2024
2 checks passed
@kevin-lee kevin-lee deleted the update-doc-site-info branch May 10, 2024 12:07
@kevin-lee
Copy link
Contributor Author

Although I often have the doc inside the project itself, I don't think having a separate doc repo is that unusual.
Having the doc site inside the project itself can have a certain benefit.
e.g.)
If you use mdoc to generate the docs, you can easily make your doc module depend on the project module. However, you can also do it with libraryDependencies.

Anyway, as I already said, I don't think having a separate doc repo is unusual. You can keep git history cleaner without doc site in the project.

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.

2 participants