Skip to content

Conversation

@selfhoster1312
Copy link

This pull request:

  • disables CI on README/docs edits
  • creates a new docs/ folder
  • removes a lot of noise from the README to keep important information readable
  • merges the wiki into the docs folder
  • creates separate folders/pages for every protocol so that it's easier to find the information you're looking for in one place (eg. when searching for how discord works and what the available settings are)
    • separate settings details for a protocol in settings.md in that subfolder
    • separate detailed account/token creation steps in account.md in that subfolder
    • removes mentions of global settings in specific protocol settings (is that a good idea?)
  • introduces common vocabulary (protocol/account/channel/gateway) throughout the docs so it's more clear what we're talking about and we can start mapping specific protocol vocabulary to a common "matterbridge docs" standard
  • removes mentions of deprecated protocols (eg. harmony/steam)
  • removes deployment instructions for specific proprietary hosts which provide little value

There's still a lot to improve but i believe this PR will help produce better docs in the long run.

Feedback/review welcome :)

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.

1 participant