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

docs: set up ir-docs #2530

Merged
merged 71 commits into from
Dec 13, 2023
Merged

docs: set up ir-docs #2530

merged 71 commits into from
Dec 13, 2023

Conversation

frankcalise
Copy link
Contributor

Describe your PR

  • Revamps documentation to be of ir-docs structure for Docusaurus

Still Needs

  • Content for docs/boilerplate-docs/Boilerplate.md
  • Content for docs/README.md
  • Link root repo README.md to remote IR docs site where Ignite documentation will live

frankcalise and others added 30 commits May 24, 2023 13:13
* fix(cli): update generator for expo only

* refactor(boilerplate): App to typescript

* chore: simplify w/ expo

* chore: reanimated deps, other dep clean up

* fix(boilerplate): removed problematic @expo/metro-config to run dev client

* chore: updated native dirs as per expo dev client build

* chore: updates to latest Expo SDK

* test: update app-icon / splash section

* fix(cli): rename bridging header and entitlements

* chore(boilerplate): dep update

* docs(folder-structure): updated for rework

* chore: updates due to structure changes, tests passing 🤞

* fix(generators): add new line to end of app.json

* chore: update reactotron dev deps

* fix(boilerplate): WelcomeScreen needs this import even if demo removed

* fix(cli): remove deprecrated expo flag

* fix(boilerplate): match babel config more closely to expo default

* chore(cli): reactotron deps

* feat(cli): prompt for enabling new arch

* chore: remove unused log statements

* chore: expect TS error for now

* chore(boilerplate): RN 0.72.3

---------

Co-authored-by: Joshua Yoes <[email protected]>
frankcalise and others added 3 commits October 16, 2023 22:18
There was a problem with the web implementation because we were directly using `DrawerLayout` from `react-native-gesture-handler`. Moving to `Drawer` from `react-native-drawer-layout` (a react-navigation product) mitigates this issue without losing any functionality.

This is the React Native boilerplate that the [Infinite Red](https://infinite.red) team uses on a day-to-day basis to build client apps. Developers who use Ignite report that it saves them two to four weeks of time on average off the beginning of their React Native project!

## Intro Video

Check out the [Getting Started with Ignite](https://www.youtube.com/watch?v=KOSvDlFyg20) video for a 13 minute overview!

## [Full Documentation](https://github.com/infinitered/ignite/blob/master/docs)

We've put great effort into the documentation as a team, please [read through it here](https://github.com/infinitered/ignite/blob/master/docs). If you're unsure why a certain decision was made related to this boilerplate or how to proceed with a particular feature, it's likely documented. If it still isn't clear, go through the proper [help channels](#reporting-bugs--getting-help) and we always welcome PRs to improve the docs!

Choose a reason for hiding this comment

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

When ir-docs goes live this will be `https://docs.infinite.red/ignite

docs/Guide.md Outdated Show resolved Hide resolved
@frankcalise frankcalise changed the base branch from master to feat/rn-72-expo-49 October 19, 2023 17:20
@markrickert
Copy link
Member

markrickert commented Oct 20, 2023

I pushed up a cleanup branch that incorporates some of the changes i'd already made locally while working on this:

  • removed -docs postfix from folders
  • moved the folder structure to the boilerplate home page
  • removed "Component" from the titles of the component pages
  • removed internal anchor link lists since docusauras does this for us on the right sidebar based on document headers.

Base automatically changed from feat/rn-72-expo-49 to master November 16, 2023 22:02
@jamonholmgren
Copy link
Member

Got the conflicts resolved. Should be mergeable once @trevor-coleman and @frankcalise are on board.

@trevor-coleman
Copy link

trevor-coleman commented Nov 27, 2023

Took a quick look and the changes look good -- one small suggestion is to use larger gaps for the ordering numbers.

For instance instead of 1, 2, 3, you can use 100,200,300. That allows for things to be inserted later without having to edit all the files.

But I don't think it's not really necessary if there aren't a huge number of things in the list.

@trevor-coleman
Copy link

@frankcalise -- is this still good to go? @jamonholmgren was hoping to get this onto ir-docs before we launch on Monday.

@frankcalise frankcalise changed the title Docs/ir docs docs: set up ir-docs Dec 13, 2023
@frankcalise frankcalise marked this pull request as ready for review December 13, 2023 16:13
@frankcalise frankcalise merged commit 26614c5 into master Dec 13, 2023
1 check passed
@frankcalise frankcalise deleted the docs/ir-docs branch December 13, 2023 16:19
@infinitered-circleci
Copy link

🎉 This PR is included in version 9.1.1 🎉

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.

7 participants