Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mark sections normative; move algorithms #302

Merged
merged 8 commits into from
Sep 26, 2024
Merged

mark sections normative; move algorithms #302

merged 8 commits into from
Sep 26, 2024

Conversation

decentralgabe
Copy link
Collaborator

@decentralgabe decentralgabe commented Sep 18, 2024

fix #300

  • mark sections as normative, informative
  • move algorithms above non-normative section
  • combined verification and validation sections under a common 'algorithms' section

Preview | Diff

@selfissued
Copy link
Collaborator

Where can I view the rendered version of this PR? The usual "Preview" link isn't in evidence.

@iherman
Copy link
Member

iherman commented Sep 18, 2024

There seems to be some problem with the background processing that I could not track down. I believe it may be with the "spec generator". That is probably the reason why preview does not appear either.

The (complicated) way around that I found is as follows:

  • download the new branch onto the local clone of repository and ask git to make this your current branch
  • two possibilities:
    • if you run a local http server which has access to the repository, then view the index.html file in your browser via localhost
    • otherwise, go to https://labs.w3.org/spec-generator/ and upload the source code there

In theory, one could use the spec generator using https://htmlpreview.github.io/?https://github.com/w3c/vc-jose-cose/blob/fix-300/index.html to render the file, but it returns a (I believe unjustified) but report.

cc @deniak ?

@deniak
Copy link
Member

deniak commented Sep 18, 2024

As far as I can tell, spec-generator can process that document just fine, see https://labs.w3.org/spec-generator/?type=respec&url=https%3A%2F%2Fraw.githubusercontent.com%2Fw3c%2Fvc-jose-cose%2Fdcfe55993ade74facbd7d39d755e3a89dacefd66%2Findex.html&file=
@tobie, any idea why pr-preview isn't adding the links on that PR? The other PRs seem to work ok.

@iherman
Copy link
Member

iherman commented Sep 18, 2024

Hm. Maybe it is a problem with htmlpreview (I must admit I have never used this raw.githubusercontent.com trick).

index.html Outdated Show resolved Hide resolved
decentralgabe and others added 3 commits September 18, 2024 12:57
Co-authored-by: Ted Thibodeau Jr <[email protected]>
* origin/main:
  update controller doc examples (#301)
  Move Conformance section into Introduction (#299)
  Remove my name from this spec (#295)
  Add Acknowledgements section (#298)
  update respec (#303)

# Conflicts:
#	index.html
Copy link
Collaborator

@selfissued selfissued left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please delete all instances of class="normative". I verified that it doesn't change the output for normative sections, so it's just unnecessary clutter in the source, given that sections are normative by default.

@tobie
Copy link
Member

tobie commented Sep 22, 2024

@tobie, any idea why pr-preview isn't adding the links on that PR? The other PRs seem to work ok.

Not sure what the issue was here. Seems fixed now. LMK if this happens again.

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
@decentralgabe
Copy link
Collaborator Author

Opened over a week. Changes addressed. Editorial approval. Merging.

@decentralgabe decentralgabe merged commit 1a8a350 into main Sep 26, 2024
2 checks passed
decentralgabe pushed a commit that referenced this pull request Sep 26, 2024
* origin/main:
  mark sections normative; move algorithms (#302)

# Conflicts:
#	index.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Almost no sections are class="normative". Why?
6 participants