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

Link documentation to official errbot site #84

Merged
merged 4 commits into from
Sep 25, 2023
Merged

Conversation

nzlosh
Copy link
Collaborator

@nzlosh nzlosh commented Sep 26, 2022

To avoid duplicating maintenance effort between the readme and the official documentation, the README will now link to errbot's official documentation.

@nzlosh
Copy link
Collaborator Author

nzlosh commented Sep 26, 2022

This PR is to be merged after errbotio/errbot#1602 and the official documentation has been published.

@sijis
Copy link
Collaborator

sijis commented Sep 28, 2022

I believe it should be the other way around. The main docs should point to here.

  • Installing and setup will likely change at a faster pace
  • The backend docs are more representative of what is actually going on
  • Easier to iterate on changes/documentation

@nzlosh
Copy link
Collaborator Author

nzlosh commented Sep 28, 2022

I was in favour of using the errbot documentation for the following reasons:

  • central point for all errbot documentation.
  • branded (colour theme and logo) with table of contents and pages by category for easier navigation.
  • dedicated documentation site gives a more mature/professional image of the project than github readme.
  • provides cohesive experience without being sent off site.

That said, I agree with all the points you're making and wonder if it would be possible to move the documentation into its own repository so that it can be maintained by core and backend devs with it's own release cycle? Alternatively, perhaps creating a readthedocs page dedicated to the slackv3 backend may be a reasonable compromise?

@sijis
Copy link
Collaborator

sijis commented Oct 6, 2022

Moving the documentation to its own repo seems appealing but the api documentation is built based on the codebase.

I think it does make sense to include a "quick setup" guide on the main site but add a link to the slackv3 repo that includes more details an examples in the README, like updating messages, replying in a thread, etc.

That should solve the ideas of keeping a similar branding and central document and includes the flexibility for the repo to add additional context/information about features of the backend.

@nzlosh
Copy link
Collaborator Author

nzlosh commented Sep 14, 2023

@sijis I've added the quick start instructions as you suggested. This PR includes the sphinx configuration for readthedocs as well a few spelling corrections.

@nzlosh nzlosh requested a review from sijis September 14, 2023 07:37
@nzlosh nzlosh merged commit a6634b6 into errbotio:main Sep 25, 2023
4 checks passed
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