Skip to content

Docs/improve formatting v2 #209

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

IVedantD
Copy link

Documentation Formatting and Style Improvements v2

This PR improves documentation formatting and consistency across multiple files by addressing markdown linting issues and improving readability.

Changes Made

  • Fixed line length issues to stay under 80 characters
  • Added missing language specifiers to code blocks
  • Fixed spacing around lists, code blocks, and headings
  • Improved YAML configuration in mkdocs.yml
  • Made text more concise and readable
  • Standardized formatting across documentation

Files Updated

  • docs/tutorials/building_r.md

    • Added blank lines around fences and lists
    • Fixed code block formatting
    • Improved spacing around images
  • docs/container_setup/github_codespace/creating_codespace.md

    • Fixed line length issues
    • Improved formatting of lists and notes
    • Made text more concise
  • docs/tutorials/contribution_workflow.md

    • Fixed multiple consecutive blank lines
    • Added blank lines around headings
    • Fixed code block style and language specifiers
  • mkdocs.yml

    • Fixed emoji configuration
    • Updated markdown extensions configuration
    • Improved overall YAML structure

Testing

  • All markdown linting issues have been resolved
  • YAML configuration has been validated
  • Documentation can be previewed using mkdocs to verify improvements

Vedant Damedhar and others added 8 commits March 27, 2025 15:17
- Standardize list formatting using proper markdown enumerated lists
- Improve section header hierarchy and titles
- Add permalinks to section headers
- Fix indentation in lists and code blocks
- Better organization of content and improved readability
- Fix line length issues in creating_codespace.md and building_r.md
- Make text more concise and readable
- Add missing language specifiers to code blocks
- Fix spacing around lists and code blocks
- Fix line length issues in contribution_workflow.md
- Remove !!python/name tags from YAML configuration
- Fix pymdownx.superfences configuration
- Improve overall formatting and readability
- Fix line length issues in building_r.md and creating_codespace.md
- Add missing language specifiers to code blocks
- Add blank lines around fences and lists
- Improve overall formatting and readability
- Use `console for terminal output
- Use `Rconsole for R console output
- Replace text-only screenshots with fenced code blocks
- Improve accessibility and maintainability
- Follow recommendations from r-devel/r-dev-day#60
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.

1 participant