Readme.md API links

Report any problems with CopperSpice
Post Reply
asahukar
Posts: 5
Joined: Sat Dec 19 2020 12:25 am

Readme.md API links

Post by asahukar »

Minor documentation point -- my pull from 11.28.2020 has a Readme.md with the following contents (API section):

The API contains full class documentation and multiple tutorials for CopperSpice. It is available on the website or
from our download page.

|URL |Description|
|---------|-----------|
|www.copperspice.com/docs/cs_api_1.5/index.html|CopperSpice 1.5 (stable)|
|www.copperspice.com/docs/cs_api_1.6/index.html|CopperSpice 1.6|
| | |

Both links map to www.copperspice.com/docs/cs_api/index.html with no problem -- that works well.

It might be clearer to separate the documentation of the stable version from the API URL, which presumably will now no longer need to change.

ansel
Posts: 116
Joined: Fri Apr 10 2015 8:23 am

Re: Readme.md API links

Post by ansel »

asahukar wrote:
Sat Dec 19 2020 2:10 am
It might be clearer to separate the documentation of the stable version from the API URL, which presumably will now no longer need to change.
Thanks for reminding us we forgot to push the commit which updates the Readme.
Ansel Sermersheim
CopperSpice Cofounder

Post Reply