Skip to content

Conversation

@bacongobbler
Copy link
Contributor

This conforms with SKIP 00x - Documenting Spinkube: spinframework/skips#7

Signed-off-by: Matthew Fisher [email protected]

This conforms with SKIP 00x - Documenting Spinkube

Signed-off-by: Matthew Fisher <[email protected]>
Copy link
Contributor

@vdice vdice left a comment

Choose a reason for hiding this comment

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

Just a few questions (mentioning here and related to the corresponding section in the SIP):

  1. Does/should the hard wrap apply to other files under content besides those under docs? (For example, about, blog, etc)
  2. Do we want to add any tooling/process around trying to maintain the 100-char limit going forward?

@bacongobbler
Copy link
Contributor Author

bacongobbler commented Aug 19, 2024

Does/should the hard wrap apply to other files under content besides those under docs? (For example, about, blog, etc)

I didn't want to impose this rule to content that sits in the blog or the about page. However I'd be okay with applying it to those other locations as well. What do you think?

Do we want to add any tooling/process around trying to maintain the 100-char limit going forward?

Because it's just a developer thing to aid in readability, I don't think it's necessary to impose this as a strict rule. What are your thoughts?

I've been using Rewrap to format my documents. We could add that as a suggested VSCode extension. Perhaps there's also a way for markdownlint to catch these as linter rules, too.

@vdice
Copy link
Contributor

vdice commented Aug 19, 2024

I didn't want to impose this rule to content that sits in the blog or the about page. However I'd be okay with applying it to those other locations as well. What do you think?

I don't have a strong opinion but would be in support of applying to those locations in this PR if you were, even if not a restriction enforced by the SIP.

Because it's just a developer thing to aid in readability, I don't think it's necessary to impose this as a strict rule. What are your thoughts?

I think one or both of the suggested extension and markdown rule might be nice; definitely follow-up material :)

@bacongobbler bacongobbler merged commit d8217e9 into main Aug 19, 2024
@bacongobbler bacongobbler deleted the wrap-100-characters branch August 19, 2024 15:34
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.

3 participants