search

howdyai / botkit

Botkit is an open source developer tool for building chat bots, apps and custom integrations for major messaging platforms.
MIT License
11.39k stars 2.28k forks source link

Should we deploy the docs on GitHub pages or some other alternatives? #2180

Open deepakmahakale opened 2 years ago

deepakmahakale commented 2 years ago

It will be easier to go through the docs if they are deployed somewhere with navigation like the previous site used to do.

I tried to move the docs to root and use GitHub pages but we may need to use some proper theme.

Can we move the /docs to root and try using GitHub pages?

Possible Solutions:

  1. Add the static site code to the gh-pages branch and deploy the branch using GitHub pages
  2. move the docs/ to root and deploy
  3. Any other alternatives?
benbrown commented 2 years ago

@deepakmahakale that's an interesting idea. The nav is definitely helpful, I agree.

I would hate to change the URL of the docs as it is though since it will invalidate a bunch of URLs in search engines and links.

Does it have to be included in a gh-pages branch?

The process that builds the markdown files can be updated to write to multiple locations...

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.