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

Update documentation to fix typos and update consistency #333

Merged
merged 1 commit into from
Dec 22, 2024

Conversation

holmesadam
Copy link
Contributor

No description provided.

Copy link

what-the-diff bot commented Dec 4, 2024

PR Summary

  • Enhancement of Documentation Readability
    This PR includes multiple modifications in the language used throughout various documentation files to make the content easier to understand and correct any grammar inconsistencies.

  • Standardization of Terms
    Changes have been made for uniformity in the use of certain terms across the documentation. Notably, the term 'datasource' now consistently appears as 'data source'.

  • Improvement in Content Formatting
    Formatting enhancements in different parts of the documentation have been made including for headings, bullet point lists, and highlighted sections to provide a more coherent reading experience.

  • Content Enrichment in Advanced Tables
    The instructions and descriptions in advanced-tables.md have been expanded, including information on how to use the Advanced Tables Plugin.

  • Clarifications on Embedding Forms
    The instructions and warnings about embedding forms in usage/embed.md and other sections have been made more explicit for user understanding.

  • Added Note For Trait Usage
    A note has been added in custom-designer.md and custom-schemata.md to guide users on the right way to use the trait.

  • Typographical Fixes
    Minor typographical errors have been corrected, with a focus on maintaining sentence capitalization uniformity.

  • Updated Introductions for Clarity
    In the introductory section, confusion has been reduced by replacing "here is the structure of the table" with "Here is the structure of the database tables".

  • Sentence Endings
    A period has been added to punctuate the sentence: "options like columns number."

  • Completeness of Information
    The sentence about fields now reads "create custom ones too" for completeness.

  • Change in Phrasing for Clarity
    The previous wording "helps to query any reports you want with ease" has been replaced by "helps to create any reports you want with ease" for improved comprehension.

@atmonshi
Copy link
Member

Thank you @holmesadam so much for all these PRs 🙏🏽
and sorry for the delay.

will start testing and review them and will let know if any changes needed.

@atmonshi atmonshi merged commit d71bdcb into lara-zeus:3.x Dec 22, 2024
2 checks passed
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.

2 participants