search

exercism / legacy-docs

Other
84 stars 55 forks source link

Begin adding information to exercise anatomy metadata section. #99

Closed Insti closed 6 years ago

Insti commented 7 years ago

Basic information taken from: https://github.com/exercism/problem-specifications/blob/master/README.md#problem-metadata

This provides a starting point for consolidating documentation about the metadata files.

Insti commented 7 years ago

Other relevant metadata information can be found here: https://github.com/exercism/docs/blob/master/you-can-help/make-up-new-exercises.md

And possibly should be moved into this document by a future PR.

Insti commented 7 years ago

I think there is some inconsistency here,

I think there are some conceptual issues with the way this documentation is currently laid out.

To me, exercise anatomy covers both what is in the track AND what is in problem-specifications. Perhaps these should be addressed in separate documents within this directory and cross linked as appropriate.

Insti commented 7 years ago

See also: https://github.com/exercism/docs/issues/100 where I try to gain clarity on document locations.

Insti commented 6 years ago

Closing this, as it was written for version 1. Some of the information may still be relevant for version 2 but I don't feel I know enough to comment authoritatively.

Feel free to use what was here if it is still relevant and you want to make a new PR.