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

chore: update docs #686

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

chore: update docs #686

wants to merge 5 commits into from

Conversation

j-yw
Copy link
Contributor

@j-yw j-yw commented Oct 31, 2024

updated some docs for nameMapper config object.

@j-yw j-yw requested a review from Zetazzz October 31, 2024 08:59
@j-yw j-yw marked this pull request as ready for review November 1, 2024 02:31
@Zetazzz
Copy link
Collaborator

Zetazzz commented Nov 1, 2024

Hi, nice!

There's another readme under packages/telescope, please do the sync too, then I'll merge!

Thank you very much!

README.md Outdated
@@ -1098,6 +1102,66 @@ const options: TelescopeOptions = {
};
```

## Name Mappers Configuration
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the top level of this should be sth like: Helper Functions. And include this part inside.

And under the Options of Helper Functions, We can have a reference like others did:

See Helper Functions for more info.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, can you please take another look, 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.

2 participants