Skip to content

Docs: Cleanup readme#121

Merged
GaryJones merged 1 commit into
developfrom
fix/readme
Mar 14, 2022
Merged

Docs: Cleanup readme#121
GaryJones merged 1 commit into
developfrom
fix/readme

Conversation

@GaryJones
Copy link
Copy Markdown
Collaborator

  • Add line breaks to top headers.
  • Remove redundant trailing heading markdown delimiters.
  • Add configuration guide from now-removed wpvip.com page.
  • Fix some typos and missing code delimiters.
  • Use ordered numbers for installation list as this then looks better when reading the raw markdown file.
  • Remove headings for individual screenshot references.
  • Switched fenced code blocks to use tildes as this works better with the readme parser on WPORG.
  • Reformated code blocks to better follow WP coding standards.

Also, removed readme.txt to keep a canonical source of information.

- Add line breaks to top headers.
- Remove redundant trailing heading markdown delimiters.
- Add configuration guide from now-removed wpvip.com page.
- Fix some typos and missing code delimiters.
- Use ordered numbers for installation list as this then looks better when reading the raw markdown file.
- Remove headings for individual screenshot references.
- Switched fenced code blocks to use tildes as this works better with the readme parser on WPORG.
- Reformated code blocks to better follow WP coding standards.

Also, removed readme.txt to keep a canonical source of information.
@GaryJones GaryJones added the type: maintenance Routine maintenance and code quality improvements label Mar 14, 2022
@GaryJones GaryJones added this to the 0.6 milestone Mar 14, 2022
@GaryJones GaryJones self-assigned this Mar 14, 2022
@GaryJones GaryJones merged commit b0ad249 into develop Mar 14, 2022
@GaryJones GaryJones deleted the fix/readme branch March 14, 2022 10:13
@GaryJones GaryJones added type: documentation Documentation improvements and removed type: maintenance Routine maintenance and code quality improvements labels Mar 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant