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

Documentation Enhancements #383

Merged
merged 8 commits into from
Oct 16, 2023

Conversation

jescalada
Copy link
Contributor

Hi, I'd like to make a few minor changes to the documentation files to make them more readable.

Changes:

  • Added headers to separate content into bite-sized pieces
    • Makes the documentation easier to browse
    • Improves SEO by adding context to each document
  • Standardized whitespaces and punctuation
    • Slightly improves readability (especially for anybody editing docs)
  • Reordered Writing.md schema creation section to have high-level API shown first, and added an internal link to an example of the graph API
    • This improves developer experience by emphasizing the easier way of doing things while also giving an example for the lower-level API
  • Fixed various typos and improved wording
    • Fixed minor typo in code snippet
    • Fixed references to LogicalColumnWriter and LogicalColumnReader to aid SEO

Feel free to recommend any changes you see fit, particularly regarding the header names if you feel they aren't relevant enough.

Thank you!

Copy link
Contributor

@adamreeve adamreeve left a comment

Choose a reason for hiding this comment

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

These changes all look great thanks @jescalada

@adamreeve adamreeve merged commit 69afa87 into G-Research:master Oct 16, 2023
28 checks passed
@jescalada
Copy link
Contributor Author

Thank you! 😄

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.

None yet

2 participants