Some missing docs?

[Rick Byers]

Hi,
The ReSpec user's guide
<https://www.google.ca/url?sa=t&rct=j&q=&esrc=s&source=web&cd=2&cad=rja&uact=8&ved=0ahUKEwjh0q3Mk93NAhVl3IMKHXy4CR0QFggjMAE&url=https%3A%2F%2Fw3c.github.io%2Frespec-docs%2Fguide.html&usg=AFQjCNH52Iah4HkL_ENYsLQ6qeH0SBODNA&sig2=48W533_fpE1Etvzsb-IHQg&bvm=bv.126130881,d.amc>
used
to contain a bunch of guidance on how to properly do linking including to
other specs (eg. [[SPEC]] vs. [[!SPEC]] syntax). As far as I can tell,
none of that documentation has survived in the new wiki
<https://github.com/w3c/respec/wiki>. Am I just missing it? If the wiki
is indeed still incomplete, are the old docs still saved somewhere (better
than the Google cache
<https://webcache.googleusercontent.com/search?q=cache:ZcAfTUz-uKgJ:https://w3c.github.io/respec-docs/guide.html+&cd=2&hl=en&ct=clnk&gl=ca>
I've been using)?

The specific question I was looking for was whether it's possible to refer
to the ED version of a spec (and ideally a specific anchor inside the spec
instead of just to the whole document generally). I'm guessing the answer
is no, and for both cases I should just use <a> tags with explicit URLs,
right?

Thanks,
Rick

[Shane McCarron]

I don't know what's up with the documentation but there is no good easy to
reference inside of a spec other than an a tag.

Post by Rick Byers
Hi,
The ReSpec user's guide
<https://www.google.ca/url?sa=t&rct=j&q=&esrc=s&source=web&cd=2&cad=rja&uact=8&ved=0ahUKEwjh0q3Mk93NAhVl3IMKHXy4CR0QFggjMAE&url=https%3A%2F%2Fw3c.github.io%2Frespec-docs%2Fguide.html&usg=AFQjCNH52Iah4HkL_ENYsLQ6qeH0SBODNA&sig2=48W533_fpE1Etvzsb-IHQg&bvm=bv.126130881,d.amc> used
to contain a bunch of guidance on how to properly do linking including to
other specs (eg. [[SPEC]] vs. [[!SPEC]] syntax). As far as I can tell,
none of that documentation has survived in the new wiki
<https://github.com/w3c/respec/wiki>. Am I just missing it? If the wiki
is indeed still incomplete, are the old docs still saved somewhere (better
than the Google cache
<https://webcache.googleusercontent.com/search?q=cache:ZcAfTUz-uKgJ:https://w3c.github.io/respec-docs/guide.html+&cd=2&hl=en&ct=clnk&gl=ca>
I've been using)?
The specific question I was looking for was whether it's possible to refer
to the ED version of a spec (and ideally a specific anchor inside the spec
instead of just to the whole document generally). I'm guessing the answer
is no, and for both cases I should just use <a> tags with explicit URLs,
right?
Thanks,
Rick

[Rick Byers]

Thanks.

And now I've found the thread
<https://lists.w3.org/Archives/Public/spec-prod/2016AprJun/0108.html> where
Marcos says he's in the process of migrating the docs, so presumably that's
just still work-in-progress (despite the old docs site being gone already).

Post by Shane McCarron
I don't know what's up with the documentation but there is no good easy to
reference inside of a spec other than an a tag.

Post by Rick Byers
Hi,
The ReSpec user's guide
<https://www.google.ca/url?sa=t&rct=j&q=&esrc=s&source=web&cd=2&cad=rja&uact=8&ved=0ahUKEwjh0q3Mk93NAhVl3IMKHXy4CR0QFggjMAE&url=https%3A%2F%2Fw3c.github.io%2Frespec-docs%2Fguide.html&usg=AFQjCNH52Iah4HkL_ENYsLQ6qeH0SBODNA&sig2=48W533_fpE1Etvzsb-IHQg&bvm=bv.126130881,d.amc> used
to contain a bunch of guidance on how to properly do linking including to
other specs (eg. [[SPEC]] vs. [[!SPEC]] syntax). As far as I can tell,
none of that documentation has survived in the new wiki
<https://github.com/w3c/respec/wiki>. Am I just missing it? If the
wiki is indeed still incomplete, are the old docs still saved somewhere
(better than the Google cache
<https://webcache.googleusercontent.com/search?q=cache:ZcAfTUz-uKgJ:https://w3c.github.io/respec-docs/guide.html+&cd=2&hl=en&ct=clnk&gl=ca>
I've been using)?
The specific question I was looking for was whether it's possible to
refer to the ED version of a spec (and ideally a specific anchor inside the
spec instead of just to the whole document generally). I'm guessing the
answer is no, and for both cases I should just use <a> tags with explicit
URLs, right?
Thanks,
Rick

[Marcos Caceres]

Post by Rick Byers
Thanks.
And now I've found the thread
where
Marcos says he's in the process of migrating the docs, so presumably that's
just still work-in-progress (despite the old docs site being gone already).

So, I had copied most of the text from the guide into the appropriate
ReSpec options, but you are correct that I didn't bring over the full
guide (so simple things like "how do I link?" were indeed missing).

I've added the guide here:

https://github.com/w3c/respec/wiki/User's-Guide

It needs a bit of editing - but all the essentials are now there.

Note that ReSpec does not yet support BS's super fancy cross-document
linking. I would like to work on that next month, after we finish the
transition to HTTPS-everywhere and the new PubRules checker is up an
running.

Kind regards,
Marcos

[Rick Byers]

Awesome, thanks Marcos!

Post by Rick Byers

Post by Rick Byers
Thanks.
And now I've found the thread
where
Marcos says he's in the process of migrating the docs, so presumably

that's

Post by Rick Byers
just still work-in-progress (despite the old docs site being gone

already).
So, I had copied most of the text from the guide into the appropriate
ReSpec options, but you are correct that I didn't bring over the full
guide (so simple things like "how do I link?" were indeed missing).
https://github.com/w3c/respec/wiki/User's-Guide
It needs a bit of editing - but all the essentials are now there.
Note that ReSpec does not yet support BS's super fancy cross-document
linking. I would like to work on that next month, after we finish the
transition to HTTPS-everywhere and the new PubRules checker is up an
running.
Kind regards,
Marcos