accordproject / techdocs

Accord Project Documentation
Apache License 2.0
60 stars 133 forks source link

README link not updated to v0.21 #351

Closed Poppy22 closed 3 years ago

Poppy22 commented 3 years ago

Bug Report 🐛

In the README, the link from How to use the Cicero Templating System (the third one from Documentation) points to How to use a template page, which has instructions from v0.13 instead of v0.21.

Expected Behavior

I believe the link should actually point to up-to-date documentation (v0.21).

Current Behavior

A newcomer might end up combining instructions from the two versions, resulting in error / confusion. Here is a summary of the tutorial:

(This happened to me :D)

Possible Solution

The solution is simple, to update the link in the README from https://docs.accordproject.org/docs/basic-use.html to https://docs.accordproject.org/docs/started-hello.html.

Or to create a basic-use.html page for v0.21 (the existing one is for v0.13), with updated instructions.

I will make a PR to update the link. (the first proposed solution)

Steps to Reproduce

  1. Open the link from the README.
  2. Follow the tutorial.
jolanglinais commented 3 years ago

Context from @jeromesimeon:

I'm very tempted to remove all this part of the README and point to the techdocs. Or we'll end up again with X PRs to review all a little bit different.

I mostly agree. We need to have a systematic approach to making these docs both more maintainable and at least as accessible.

Priyaraj17 commented 3 years ago

Is this issue open? I would like to work on it.

Poppy22 commented 3 years ago

@irmerk @jeromesimeon I will update the PR based on your feedback, so I should simply delete the Documentation section in the README. There is a link to the documentation in the Overview section already.

@Priyaraj17 I have already started working on this yesterday :D

jolanglinais commented 3 years ago

I don't think it's a simple as deleting the Documentation section in the README. This will take some thought and I'm not sure yet.

jolanglinais commented 3 years ago

I believe this is no longer an issue after #358