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

Add introduction content and adjust linting #28

Merged
merged 4 commits into from
May 8, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented May 6, 2024

Description

This PR adds more content to the introduction about what the Almanac will cover and who it's for.

During changes here, I also found I needed to reconfigure vale linting in order for it to work properly (both the poethepoet task and removing write-good.Passive checks as this was emitting false negatives). I also added the branding logo as the almanac logo.

Thanks for any feedback you may have!

Closes #15

What is the nature of your change?

  • Content additions or updates (adds or updates content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own contributions.
  • I have commented my content, particularly in hard-to-understand areas.
  • I have made corresponding changes to related documentation (outside of book content).
  • My changes generate no new warnings.
  • New and existing tests pass locally with my changes.
  • I have added tests that prove my additions are effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

Copy link
Member

@gwaybio gwaybio left a comment

Choose a reason for hiding this comment

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

LGTM! Minor comments and suggestions

src/almanac/introduction.md Show resolved Hide resolved
src/almanac/introduction.md Outdated Show resolved Hide resolved
src/almanac/introduction.md Outdated Show resolved Hide resolved
src/almanac/introduction.md Outdated Show resolved Hide resolved
src/almanac/introduction.md Show resolved Hide resolved
src/almanac/introduction.md Outdated Show resolved Hide resolved
src/almanac/introduction.md Outdated Show resolved Hide resolved
src/almanac/introduction.md Outdated Show resolved Hide resolved
src/almanac/introduction.md Outdated Show resolved Hide resolved
src/almanac/introduction.md Outdated Show resolved Hide resolved
Copy link

netlify bot commented May 8, 2024

Deploy Preview for test-almanac failed.

Name Link
🔨 Latest commit 5055e62
🔍 Latest deploy log https://app.netlify.com/sites/test-almanac/deploys/663bb75e4dcc4100080f96c7

@d33bs
Copy link
Member Author

d33bs commented May 8, 2024

Thank you @gwaybio ! Merging this in.

@d33bs d33bs merged commit f34d577 into software-gardening:main May 8, 2024
2 checks passed
@d33bs d33bs deleted the add-introduction branch May 8, 2024 21:20
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.

Add introduction section
2 participants