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

Apply the new design to the guidebook #267

Draft
wants to merge 211 commits into
base: main
Choose a base branch
from
Draft

Apply the new design to the guidebook #267

wants to merge 211 commits into from

Conversation

deniak
Copy link
Member

@deniak deniak commented Nov 20, 2024

@lcarcone @vivienlacourba, I'm starting this PR to redesign the guidebook.
I've redesigned 2 pages for the example:

  1. the documentreview with a HTML to markdown conversion. That method will take a while unless we can find a good tool to convert the markdown but it can be tricky as some parts of the page may still require HTML (you will see I left some tags, e.g. details/summary, dl/dt/dd)
  2. the standards-track index page where I kept most of the initial HTML

Happy to schedule a call to discuss the details with you

@deniak
Copy link
Member Author

deniak commented Nov 21, 2024

/cc @caribouW3

@TallTed
Copy link
Member

TallTed commented Dec 2, 2024

It would be far easier to review this if there were a pr-preview or similar. What are the chances such could be instituted?

@deniak
Copy link
Member Author

deniak commented Dec 3, 2024

It would be far easier to review this if there were a pr-preview or similar. What are the chances such could be instituted?

@TallTed it might be difficult to integrate this with pr-preview. pr-preview works for specs that use a generator such as respec and bikeshed and it's meant to preview a single file.
In that particular case, jekyll generates pages for the whole repository which could represent a lot of files.

@TallTed
Copy link
Member

TallTed commented Dec 3, 2024

pr-preview works for specs that use a generator such as respec and bikeshed and it's meant to preview a single file

OK, pr-preview isn't a suitable tool, here. That possibility is why I said "or similar".

chair/role.md Outdated Show resolved Hide resolved
chair/meetings.md Outdated Show resolved Hide resolved
chair/role.md Outdated Show resolved Hide resolved
council/council.md Outdated Show resolved Hide resolved
council/council.md Outdated Show resolved Hide resolved
council/council.md Outdated Show resolved Hide resolved
teamcontact/liaison-role.md Outdated Show resolved Hide resolved
teamcontact/liaison-role.md Outdated Show resolved Hide resolved
teamcontact/liaison-role.md Outdated Show resolved Hide resolved
teamcontact/role.md Outdated Show resolved Hide resolved
transitions/details.md Outdated Show resolved Hide resolved
other/elected-body-communication-guidelines.md Outdated Show resolved Hide resolved
council/council.md Outdated Show resolved Hide resolved
@TallTed
Copy link
Member

TallTed commented Dec 18, 2024

This is a HUGE change to the document. It's near impossible to coherently review, made worse by the apparent mix of markup and content changes. I cannot recommend strongly enough that this PR be re-attempted as multiple PRs, breaking it into at least changes to content and changes to markup, if not into multiple PRs comprising each of these. Lacking such breakup, it is all but certain that unintended changes will go undetected.

Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

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

Editorial. Typos and such.

process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
process/predicting-milestones.md Outdated Show resolved Hide resolved
@vivienlacourba vivienlacourba self-requested a review January 7, 2025 07:23
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.

4 participants