fix: Fixes 283 #285
fix: Fixes 283 #285
Conversation
|
|
||
| Create a branch in this format: `feature/<issue-id>-<issue-name>` (for example, `feature/235-contact-panel`) and add accompanying test cases. | ||
|
|
||
| For guidelines, read [Issue triage](/docs/handbook/engineering/issue-triage) and [Pull Request Guidelines](/docs/handbook/engineering/pr-guidelines). | ||
|
|
||
| ### Environment Setup for local development |
There was a problem hiding this comment.
From the structure, I understand that the left pane provides navigation to topics under top menu item (ie. Contributing Guide, User Guide, etc.), and the right navigation provides navigation to in-page topics.
Based on this, I feel that we could remove the topics after this as they seem redundant here since they can be accessed from the left pane, which IMO is the logical order users will look into.
| @@ -1,40 +1,33 @@ | |||
| --- | |||
| title: "Contributing Guide" | |||
| sidebar_label: "Introduction" | |||
| title: "Introduction" | |||
There was a problem hiding this comment.
Tried to align the title as in this page https://www.chatwoot.com/docs/product
| @@ -26,4 +26,4 @@ yarn build | |||
|
|
|||
| This command generates static content into the `build` directory and can be served using any static contents hosting service. | |||
|
|
|||
| Please feel free to suggest any changes. See our [contributing guide](https://www.chatwoot.com/docs/contributing-guide) to get started. | |||
| Please feel free to suggest any changes. See our [Contributor Guide](https://www.chatwoot.com/docs/contributing-guide) to get started. | |||
There was a problem hiding this comment.
Changing the file name for consistency could align it better.
| Please feel free to suggest any changes. See our [Contributor Guide](https://www.chatwoot.com/docs/contributing-guide) to get started. | |
| Please feel free to suggest any changes. See our [Contributor Guide](https://www.chatwoot.com/docs/contributor-guide) to get started. |
|
|
||
| ### Pull Request Guidelines |
There was a problem hiding this comment.
Removed this heading as it can be confused with https://www.chatwoot.com/docs/handbook/engineering/pr-guidelines. Instead I have tried to club together with the section above that tries to list the workflow from creating an issue to ending with a PR.
…ting-guide-update
|
@naveenchkrvrthy Closing this PR since it has been stale for a while. If you decide to take it forwards, lets work on changes in smaller iteration, one or two pages at a time. it will be simpler for the team to review and merge. Also lets create an issue and discuss the changes if there are significant layout changes. |
This PR supercedes #284.
The changes may seem massive, but I have ensured not to remove any content. It majorly tries to improve:
Please find comments inline for specific discussions.