search

crate / crate-docs

Common build system, QA tools, style guides, and other meta miscellanies for doing docs at Crate.io.
Apache License 2.0
2 stars 1 forks source link

Chore: Some documentation updates #62

Closed amotl closed 3 years ago

amotl commented 3 years ago

Hi Naomi,

this patch primarily attaches to https://github.com/crate/crate-dbal/pull/109#pullrequestreview-596129187, but also adds some more adjustments.

With kind regards, Andreas.

amotl commented 3 years ago

When already being at it...

I believe the current version badge might be misleading. It (currently) shows version 0.4.1, but there is no version like that. Shall we decrease the version in build.json or say 0.4.0-snapshot there? We might also just use the Git tag badge there.

nomicode commented 3 years ago

@amotl the build version should be "0.4.0". good catch. think that was just a typo. we only update it during the release process, so "-snapshot" isn't necessary

also, as a side note, because this is the test project for the build system. it will always install the local version of the build system on your local machine, to allow for testing of unreleased versions. the build.json file is there to make the test project a complete reference implementation, but is, in fact, ignored when ../src/rules.mk is detected

https://github.com/crate/crate-docs/blob/05606360077d196daf6f8fc3364b16762a0d6ff3/docs/Makefile#L50-L60

amotl commented 3 years ago

the build version should be "0.4.0". good catch. think that was just a typo.

Thanks for clarifying. I've also adjusted this.