ruby icon indicating copy to clipboard operation
ruby copied to clipboard

Create docs configuration

Open iHiD opened this issue 4 years ago • 1 comments

This is a new config file for docs that will get merged into all repos. There will be some CI rules around it:

  • Unique uuids (globally)
  • Unique slugs (within track)
  • Valid paths (from repo apex)
  • Required title
  • Optional blurb

The four slugs present in this file are all required and immutable. Other slugs can be added.

This is a WIP version for Ruby.

iHiD avatar Mar 18 '21 15:03 iHiD

Are there ways to link to the other doc, from a doc? Will that be URL based?

You can link to relative docs in the same folder. (e.g. If you don't have Ruby installed check out [the installation docs](./testing).)

If we'd had all the docs in one repo, you could also have used relative links across docs, but the link-checker CI will fail on those now, so you'll have to use full URLs instead, and rely on the link checker for the safety of those.

iHiD avatar Mar 18 '21 16:03 iHiD

@ErikSchierboom Do you know what needs to be done here to get this over the finish line?

kytrinyx avatar Oct 13 '22 13:10 kytrinyx

@kytrinyx I do. This PR can be closed, as this file already exists: https://github.com/exercism/ruby/blob/main/docs/config.json

See https://exercism.org/docs/tracks/ruby for the end result (there wouldn't be anything there without that file)

ErikSchierboom avatar Oct 13 '22 14:10 ErikSchierboom