Documentation for WATcher

[Echomo-Xinyu]

After some preliminary discussions, we have two ideas in the hand right now:

1. Append the WATcher document with the CATcher document while refactoring the existing project

A rough design of the updated page is as below:

Concerns:

• refactoring for CATcher can be troublesome (but doable)
• the current CATcher document repo may become too cumbersome

2. Create a separate project to host the WATcher document

Concerns:

• where should we put the documentation repository?
  • Suggested by @chunweii, we can use the existing URL https://catcher-org.github.io/WATcher-doc
  • Having a separate URL address -- not sure what would be a good one

@CATcher-org/2223s2 what do yall think?

[gycgabriel]

I'm leaning towards 1. now, because in case there are upgrades to markbind or related dependencies, it would be easier to update in one repository. The only difference is the written docs between CATcher and WATcher.

A better design would be to have a switchable header, where a drop down to change between CATcher and WATcher, so the header isn't too messy. I'm not familiar if this is supported by markbind, i.e. when it is watcher the user guide link will be to WATcher user guide page, when switched to catcher it will be CATcher user guide page.

Both are also becoming official releases for CATcher yet closely related, another reason for their docs to be together

Better ease of maintainability if the docs are together as well

[gycgabriel]

We may want to defer to @damithc opinion because this change concerns the appearance of CATcher's documentation

[damithc]

@gycgabriel makes a fair point about duplication. However, at this early stages, I'd rather keep both functional and documentation code bases of the two products separate, as they differ greatly in terms of maturity and how mission-critical they are. We can reconsider a combined code base at a later time when both products are stable and mature.

[Echomo-Xinyu]

@gycgabriel @damithc Thank you for the input! I am planning to put the WATcher document as a separate repository named as WATcher-doc and have a link to navigate from CATcher documentation to WATcher documentation.

[damithc]

and have a link to navigate from CATcher documentation to WATcher documentation.

@Echomo-Xinyu I know I mentioned something like this earlier, but there is no need for this. CATcher and WATcher are use in very different situations which means there is no need to navigate from one to the other.

[Echomo-Xinyu]

but there is no need for this.

Noted!