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.

Sign up for GitHub

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

Jump to bottom

Documentation improvements #236

Merged
merged 12 commits into from
Feb 23, 2023
Merged

Documentation improvements #236

merged 12 commits into from
Feb 23, 2023

Conversation

dhdaines
Copy link
Contributor

Various documentation improvements

@dhdaines dhdaines changed the title Docs Documentation improvements Feb 15, 2023
@dhdaines dhdaines marked this pull request as ready for review February 15, 2023 21:30
@dhdaines
Copy link
Contributor Author

Hi! Here's a preliminary cleanup of the documentation to:

  • Add an introduction with a lot of useful links to lower-level pages
  • Fill in missing descriptions
  • Make the descriptions of algorithms more consistent
  • List a number of differences from OpenFST that are useful to know

Garvys
Garvys requested changes Feb 22, 2023
View reviewed changes
Copy link
Collaborator

@Garvys Garvys left a comment

Choose a reason for hiding this comment

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

Very nice !!! Thanks for taking the time of doing this !
Small typos and then I'm good for a merge!
(Sorry for the late answer, missed the notification 😬 )

rustfst/src/algorithms/optimize.rs Outdated Show resolved Hide resolved
rustfst/src/algorithms/inversion.rs Outdated Show resolved Hide resolved
@dhdaines
Copy link
Contributor Author

Done! I will probably write some more, will make another PR for those later.

@Garvys
Copy link
Collaborator

Garvys commented Feb 22, 2023

Great !! Thanks so much 💪

Garvys
Garvys approved these changes Feb 22, 2023
View reviewed changes
Copy link
Collaborator

@Garvys Garvys left a comment

Choose a reason for hiding this comment

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

🚀

@Garvys Garvys merged commit fe492c0 into garvys-org:main Feb 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Garvys Garvys Garvys approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dhdaines @Garvys