GithubHelp home page GithubHelp logo

flipkart-incubator / ultra-docs Goto Github PK

View Code? Open in Web Editor NEW
3.0 11.0 3.0 1.49 MB

Documentation for Project Ultra : Flipkart's App-in-App experience

Home Page: https://ultra-docs.readthedocs.io/en/latest/

ultra-docs's Introduction

ultra-docs

Documentation Status

Documentation for Flipkart Ultra Platform published using MkDocs.

To read the docs visit https://ultra-docs.readthedocs.io/en/latest/

Making changes :

  • Install MkDocs python plugin : http://www.mkdocs.org/
  • Install themes : pip install mkdocs-material
  • mkdocs.yml in the root folder of this repo contains the website structure. Make changes to mkdocs.yml if you want to add a new page. Changes to this file affects the side bar navigation on the left side of the page. Unless an entry to a file is not present in the mkdocs.yml, you will get a 404 error when trying to access it.
  • index.md inside the docs folder is the index page, similarly other pages have the .md extension. Adding a new page means adding a new .md file and editing the mkdocs.yml to contain this path.
  • All files use markdown to represent content. You can write markdown directly or use tools like https://stackedit.io/ to write your documentation.
  • Once changes are made run mkdocs serve to preview it locally.
  • Commit your changes to your own branch and issue a PR to master
  • Once PR gets merged, your changes will be live automatically.

Deployment :

Deploying the documentation is automated and you dont have to do anything. All you have to do is merge the changes to master. Thats all !

Once your PR is merged to master, readthedocs.io will automatically pick the changes and compile them using mkdocs. Once compiled successfully, it will get auto deployed to the above readthedocs public link

Please contact @thekirankumar for getting access to readthedocs admin account.

ultra-docs's People

Contributors

anvaysrivastava avatar harshpandeyjiit avatar manbendrasingh avatar ojesvipandita avatar sanjari7 avatar thekirankumar avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ultra-docs's Issues

Crashlytics : iOS Crash : CoreFoundation -[NSOrderedSet initWithSet:copyItems:] #10125

Crashlytics : iOS Crash : CoreFoundation -[NSOrderedSet initWithSet:copyItems:]

Crash Item : Fatal Exception: NSInvalidArgumentException
0 CoreFoundation 0x13296c __exceptionPreprocess
1 libobjc.A.dylib 0x6028 objc_exception_throw
2 CoreFoundation 0x30dcc -[NSOrderedSet initWithSet:copyItems:]
3 UIKitCore 0xa72c24 -[UIResponder doesNotRecognizeSelector:]
4 CoreFoundation 0x137048 forwarding
5 CoreFoundation 0x1393a0 _CF_forwarding_prep_0
6 UltraSDK 0x3a698 _hidden#2304 + 52 (_hidden#2295:52)
7 libdispatch.dylib 0x1b7c _dispatch_call_block_and_release
8 libdispatch.dylib 0x2fd8 _dispatch_client_callout
9 libdispatch.dylib 0xecc8 _dispatch_main_queue_callback_4CF
10 CoreFoundation 0xadcc8 CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE
11 CoreFoundation 0xa8a24 __CFRunLoopRun
12 CoreFoundation 0xa7f40 CFRunLoopRunSpecific
13 GraphicsServices 0x3534 GSEventRunModal
14 UIKitCore 0xa43a60 UIApplicationMain
15 TCPApp 0xbad894 main + 39 (AppDelegate.swift:39)
16 libdyld.dylib 0xe18 starta

Relate Review :- firebase/firebase-ios-sdk#10125

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.