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

edit hip in browser walkthrough #1336

Merged
merged 13 commits into from
May 12, 2023
Merged

edit hip in browser walkthrough #1336

merged 13 commits into from
May 12, 2023

Conversation

samgutentag
Copy link
Contributor

No description provided.

docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@jthiller jthiller left a comment

Choose a reason for hiding this comment

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

As much as I want to love the screen recordings, they kinda make me feel a little seasick. Certainly happy to yield to other opinions on this. However the payload size is a little concerning (sneaking up on 200mb for this page).

The content looks good. Is this guide meant to encourage the broader community to submit changes to HIPs or is it geared more toward the HIP author? It might be worth noting to the reader of this doc that if they aren't the author of the HIP, they should engage in the conversation on Discord.
Maybe further note that editing HIPs which have already been voted on is discouraged.

I'd love to back off on the dependence on admonitions. I find them to be jarring to the reading experience (hard to focus on what is important to read when there are many).

@jthiller
Copy link
Contributor

followup, I think the load of the gifs keeps crashing the tab in Safari

docs/faq/edit-a-hip.mdx Outdated Show resolved Hide resolved
@samgutentag
Copy link
Contributor Author

samgutentag commented May 12, 2023

As much as I want to love the screen recordings, they kinda make me feel a little seasick. Certainly happy to yield to other opinions on this. However the payload size is a little concerning (sneaking up on 200mb for this page).

if its any consolation, I mistakenly made these on my 5k display and one was nearly half a gig when I started 😱

valid points all around. going to pull the gifs and replace with annotated images. Working on a walkthrough video to accompany this tutorial in the future as well

@samgutentag
Copy link
Contributor Author

I'd love to back off on the dependence on admonitions. I find them to be jarring to the reading experience (hard to focus on what is important to read when there are many).

good call out, Id like to find a nice format for the "key take aways" for each doc page, using the "tip" green admonition as a standing for now

@samgutentag
Copy link
Contributor Author

samgutentag commented May 12, 2023

The content looks good. Is this guide meant to encourage the broader community to submit changes to HIPs or is it geared more toward the HIP author? It might be worth noting to the reader of this doc that if they aren't the author of the HIP, they should engage in the conversation on Discord. Maybe further note that editing HIPs which have already been voted on is discouraged.

the immediate need is for the IOT PoC Working group looking to make edits, like, today. but capturing this as an issue to revisit later #1342

jthiller
jthiller previously approved these changes May 12, 2023
@samgutentag samgutentag merged commit 6e34486 into master May 12, 2023
@samgutentag samgutentag deleted the sg/writing-hips-on-github branch May 12, 2023 19:26
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.

2 participants