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(docs): Add docs for ignite boilerplate files #2634

Merged
merged 9 commits into from Feb 16, 2024

Conversation

Jpoliachik
Copy link
Contributor

@Jpoliachik Jpoliachik commented Feb 12, 2024

  • Updated Boilerplate.md to reflect current project structure
  • Added docs for several files / directories. Some may need more detail, but open to opinions!
  • Updated ordering to reflect alphabetical filesystem, for consistency (open to opinions here)

A few files that are included in a new project, but we don't currently have docs for:

  • babel.config.js
  • jest.config.js
  • metro.config.js
  • react-native.config.js
  • tsconfig.json
  • package.json
  • README
    Open to opinions on whether we want to exhaustively document every file or not. (do any of these files contain customizations that are worth documenting?)

@Jpoliachik Jpoliachik changed the title [DRAFT] Add missing documentation for ignite boilerplate feat(docs): Add docs for ignite boilerplate files Feb 14, 2024
@Jpoliachik Jpoliachik marked this pull request as ready for review February 15, 2024 16:24
Copy link
Contributor

@frankcalise frankcalise left a comment

Choose a reason for hiding this comment

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

Thanks for adding some nice content here! Just a couple of nits and I think it's good to go

docs/boilerplate/app/devtools/Devtools.md Outdated Show resolved Hide resolved
docs/boilerplate/plugins/Plugins.md Outdated Show resolved Hide resolved
@Jpoliachik Jpoliachik merged commit 218a671 into master Feb 16, 2024
1 check passed
@Jpoliachik Jpoliachik deleted the docs/add-missing-docs branch February 16, 2024 19:56
@Jpoliachik Jpoliachik changed the title feat(docs): Add docs for ignite boilerplate files chore(docs): Add docs for ignite boilerplate files Feb 16, 2024
infinitered-circleci pushed a commit that referenced this pull request Feb 16, 2024
# [9.6.0](v9.5.0...v9.6.0) (2024-02-16)

### Features

* **docs:** Add docs for ignite boilerplate files ([#2634](#2634)) ([218a671](218a671))
@infinitered-circleci
Copy link

🎉 This PR is included in version 9.6.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants