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

Fix Typo Errors and Errors in Markdown documentations #3246

Merged
merged 2 commits into from
Dec 21, 2023

Conversation

Sweetdevil144
Copy link
Contributor

@Sweetdevil144 Sweetdevil144 commented Dec 13, 2023

Improved the quality of CONTRIBUTING.md and other markdown files:

  • places where code block was left unidentified, for example bash blocks, were changed to bash code blocks.
  • Linting and Alignment issues fixed in documentations.

I do not have permission to select labels and would like admins to add enhancement and documentation label to the PR

Description

It does not actually fix #3245 because I do not have access to modified links, but I surely can change them if provided with the links.

Motivation and Context

Fixes markdown linting issues in CONTRIBUTING.md

#3245

Review Time Estimate

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@allgandalf
Copy link
Collaborator

Thanks for the PR @Sweetdevil144 ,if you're interested in contributing to the documentation further then maybe you can explore the issue : #2576 , we would appreciate your help :)

@Sweetdevil144
Copy link
Contributor Author

Sweetdevil144 commented Dec 18, 2023

@RohanSasne Sure !! I'll look more into it and create a PR for the same !! Meanwhile, I'll continue to make more documentation changes to this and notify you when I'm done with the same.

@Sweetdevil144
Copy link
Contributor Author

Ready to be merged
@RohanSasne I've made all possible documentation improvements. Just one question are documentations like NEWS.md and CHANGELOG.md auto generated? If yes, then we would need changes in configuration of auto generation file to remove some basic errors.

@mdietze
Copy link
Member

mdietze commented Dec 21, 2023

NEWS and CHANGELOG are not autogenerated. It's always good to note changes in the latter as part of a PR

@mdietze mdietze added this pull request to the merge queue Dec 21, 2023
Merged via the queue into PecanProject:develop with commit 635e00f Dec 21, 2023
7 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outdated Links in Documentations
3 participants