Skip to content

[Docs] Documentation generation instructions updated in CONTRIBUTING.md #7881

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

Merged
merged 3 commits into from
Dec 18, 2023

Conversation

DellaBitta
Copy link
Contributor

Discussion

This change updates the CONTRIBUTING.md file to better instruct users how to generate reference docs.

I noticed that the instructions to generate documentation was missing a command line argument. Additionally, upon review from @hsubox76, the documentation included instructions that were for the legacy compat docs, not the new modular docs.

Testing

NA

API Changes

NA

Copy link

changeset-bot bot commented Dec 15, 2023

⚠️ No Changeset found

Latest commit: c58a2ff

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@DellaBitta DellaBitta requested a review from hsubox76 December 15, 2023 22:18
@google-oss-bot
Copy link
Contributor

google-oss-bot commented Dec 15, 2023

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Dec 15, 2023

@DellaBitta DellaBitta marked this pull request as ready for review December 17, 2023 21:01
@DellaBitta DellaBitta requested a review from a team as a code owner December 17, 2023 21:01
@DellaBitta DellaBitta changed the title [Docs] Documentation generation instructions updated on CONTRIBUTING.md [Docs] Documentation generation instructions updated in CONTRIBUTING.md Dec 18, 2023
@DellaBitta DellaBitta merged commit 4f55ae2 into master Dec 18, 2023
@DellaBitta DellaBitta deleted the ddb-update-contributing branch December 18, 2023 18:08
@firebase firebase locked and limited conversation to collaborators Jan 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants