Site Migration: Add a documentation for the useFlowNavigator hook

[valterlorran]

Related to #

Proposed Changes

• Add documentation to the useFlowNavigator hook, as I found it difficult to understand without looking at the definition.

Why are these changes being made?

Testing Instructions

• Visual inspection is enough, as it only adds documentation.

Pre-merge Checklist

• Has the general commit checklist been followed? (PCYsg-hS-p2)
• Have you written new tests for your changes?
• Have you tested the feature in Simple (P9HQHe-k8-p2), Atomic (P9HQHe-jW-p2), and self-hosted Jetpack sites (PCYsg-g6b-p2)?
• Have you checked for TypeScript, React or other console errors?
• Have you used memoizing on expensive computations? More info in Memoizing with create-selector and Using memoizing selectors and Our Approach to Data
• Have we added the "[Status] String Freeze" label as soon as any new strings were ready for translation (p4TIVU-5Jq-p2)?
• For changes affecting Jetpack: Have we added the "[Status] Needs Privacy Updates" label if this pull request changes what data or activity we track or use (p4TIVU-aUh-p2)?

[github-actions]

Calypso Live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-119784

Jetpack Cloud live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-119784&env=jetpack

Automattic for Agencies live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-119784&env=a8c-for-agencies

[matticbot]

This PR does not affect the size of JS and CSS bundles shipped to the user's browser.

Generated by performance advisor bot at iscalypsofastyet.com.

[matticbot]

This PR modifies the release build for the following Calypso Apps:

For info about this notification, see here: PCYsg-OT6-p2

• notifications
• wpcom-block-editor

To test WordPress.com changes, run install-plugin.sh $pluginSlug add/documentation-use-flow-navigator on your sandbox.

[gabrielcaires]

Using typescript, we don't need to describe the type; you can just explain what the prop does directly over the property definition, like this example. The reason of this approach is we will have the best of both worlds, the type checking and the editor describing the type and our comment describing the intent.

The same idea is applicable to the return type, we can have another interface just describing the output.

The same for the return, we can have another interface describing the type.

[gabrielcaires]

Add documentation to the useFlowNavigator hook, as I found it difficult to understand without looking at the definition.

Thanks for the feedback and contribution.
@renatho and I were exploring ways to reduce the required work to manage a flow, but I agree some decisions are unclear without a doc.

I just left a suggestion regarding the format.

[valterlorran]

@gabrielcaires, I removed the type from the hook parameters. However, I left it for the functions provided by the hook. I also left the return types. Let me know what you think about it.