Add intra-site link instructions to docs

docs/devGuide/bootcamp/implementAFeature.md

@@ -51,6 +51,12 @@ _(Same as what we mentioned in the previous task)_
 
 By this time, you should have a good idea about how tests and documentation are written. Where possible, unit tests should also be added to ensure that the feature works as expected. Utilizing the new feature in our documentation is also encouraged so that we can get a better idea of how the feature can be used.
 
+<box type="important" light>
+
+When adding intra-site links, do remember to use tags to differentiate between the deployment environment when appropriate as mentioned in [Adding Intra-Site Links to Documentation](/devGuide/development/workflow.html#adding-intra-site-links-to-documentation)!
+
+</box>
+
 ## Create PR & Follow up with the Reviews
 
 _(Same as what we mentioned in the previous task)_

docs/devGuide/development/workflow.md

@@ -258,6 +258,42 @@ Once you're done, be sure to run the `updatetest` script mentioned [above](#upda
 
 </div>
 
+## Documenting
+
+### Adding Intra-Site Links to Documentation
+
+Due to the way MarkBind's documentation is deployed, links from the developer guide that refer to the user guide, or vice versa, have to be differentiated with <a tags="environment--combined" href="/userGuide/tweakingThePageStructure.html#plugin-tags">tags</a><a tags="environment--dg" href="https://markbind.org/userGuide/tweakingThePageStructure.html#plugin-tags">tags</a>. Intra-site links within the developer guide or user guide need not have tags. MarkBind's documentation currently has 3 tags:
+
+- `environment--combined` for deploying the User Guide and Developer Guide together
+- `environment--ug` for deployed User Guide
+- `environment--dg` for deployed Developer Guide
+
+Tags allow you to selectively filter content when building a site. Using them with the links helps to filter the correct link to be rendered for the right environment, ensuring that the correct link is created. When the User Guide and Developer Guide are deployed together, both guides have access to the files from the other, allowing the relative link to work. However, when they are deployed individually, this is not the case. Using absolute links creates the same effect as the relative link without having to have access to the files from the other guide.
+
+#### Developer Guide
+%%LINK:%%
+```markdown
+[Link Title](/userGuide/newPage.html)
+```
+
+%%REPLACED WITH:%%
+```html
+<a tags="environment--combined" href="/userGuide/newPage.html">Link Title</a>
+<a tags="environment--dg" href="https://markbind.org/userGuide/newPage.html">Link Title</a>
+```
+
+#### User Guide
+%%LINK:%%
+```markdown
+[Link Title](/devGuide/newPage.html)
+```
+
+%%REPLACED WITH:%%
+```html
+<a tags="environment--combined" href="/devGuide/newPage.html">Link Title</a>
+<a tags="environment--ug" href="https://markbind.org/devdocs/devGuide/newPage.html">Link Title</a>
+```
+
 ## Linting
 
 We follow [our style guides](../styleGuides.html). Using a linter will help check and fix some of the code style errors in your code. It will save time for both you and your code reviewer. The linting tool we use is [ESLint](https://eslint.org/) and [StyleLint](https://stylelint.io/). Here is a [gist](https://gist.github.com/nicholaschuayunzhi/bfe53dbb5f1a0f02d545d55956f9ab7e) with an explanation of the ESLint rules chosen in markbind-cli.