Modified docs - removed remaining boilerpalte

Signed-off-by: Saif Ul Islam <[email protected]>

Author: Rubix982

docs/docs/intro.md

@@ -31,26 +31,27 @@ Mapillary's Python SDK provides interfaces that remove and abstract away many un
 techniques to output an easy to understand and use GeoJSON format. Currently, all the high level interfaces can
 be found at `src/mapillary/interface.py`. It contains functions such as,
 
-- `get_image_close_to` -
-- `get_image_looking_at` -
-- `get_detections_with_image_id` -
-- `get_detections_with_map_feature_id` - 
-- `image_thumbnail` -
-- `images_in_bbox` -
-- `sequences_in_bbox` -
-- `map_feature_points_in_bbox` -
-- `traffic_signs_in_bbox` -
-- `images_in_geojson` -
-- `images_in_shape` -
-- `map_features_in_geojson` -
-- `map_features_in_shape` -
-- `feature_from_key` -
-- `image_from_key` - 
+- `get_image_close_to` - Function that takes a longitude, latitude as argument and outputs the near images.
+- `get_image_looking_at` - Function that takes two sets of latitude and longitude, where the 2nd set is the
+    "looking at" location from 1st set's perspective argument and outputs the near images.
+- `get_detections_with_image_id` - Extracting all the detections within an image using an image key.
+- `get_detections_with_map_feature_id` - Extracting all detections made for a map feature key.
+- `image_thumbnail` - Gets the thumbnails of images from the API.
+- `images_in_bbox` - Gets a complete list of images with custom filter within a BBox.
+- `sequences_in_bbox` - Gets a complete list of all sequences of images that satisfy given filters within a BBox.
+- `map_feature_points_in_bbox` - Extracts map feature points within a bounding box (bbox).
+- `traffic_signs_in_bbox` - Extracts traffic signs within a bounding box (bbox).
+- `images_in_geojson` - Extracts all images within a shape.
+- `images_in_shape` - Extracts all images within a shape or polygon.
+- `map_features_in_geojson` - Extracts all map features within a GeoJSON's boundaries.
+- `map_features_in_shape` - Extracts all map features within a shape/polygon.
+- `feature_from_key` - Gets a map feature for the given key argument.
+- `image_from_key` - Gets an image for the given key argument.
 - `save_locally` - saving data locally
 
 ## The What
 
-## Getting Started
+### Getting Started
 
 Get started by **installing the mapillary package**.
 
@@ -60,26 +61,29 @@ pip install mapillary
 
 Or **try Mapillary immediately** with **[Google Colab](https://colab.research.google.com/drive/1BPWMP5k7QhXFB6nlWckHC1r54vIR0v2L?usp=sharing)**!
 
-## Test Out Interfaces
+### Test Out Interfaces
 
-Start by importing `mapillary.interface`
+Start by importing `mapillary.interface` as the following,
 
-Generate a new Docusaurus site using the **classic template**:
+```python
+"""
+On importing the interface
+"""
 
-```shell
-npx @docusaurus/init@latest init my-website classic
-```
+import mapillary.interface as mly
 
-## Start your site
+# And then simply import the desired interface
+# For example, like
+mly.get_image_looking_at(...)
+```
 
-Run the development server:
+### Check out more submodules
 
-```shell
-cd my-website
+Like ths,
 
-npx docusaurus start
+```python
+import mapillary.config as mly_config # Importing desired configurations
+import mapillary.controller as mly_controller # Importing desired controllers
+import mapillary.models as mly_models # Importing the used models
+import mapillary.utils as mly_utils # Importing utility material
 ```
-
-Your site starts at `http://localhost:3000`.
-
-Open `docs/intro.md` and edit some lines: the site **reloads automatically** and display your changes.

docs/docusaurus.config.js

@@ -30,9 +30,13 @@ module.exports = {
           type: 'doc',
           docId: 'intro',
           position: 'left',
-          label: 'Tutorial',
+          label: 'Documentation',
+        },
+        {
+          href: 'https://colab.research.google.com/drive/1BPWMP5k7QhXFB6nlWckHC1r54vIR0v2L?usp=sharing',
+          label: 'Demo',
+          position: 'left',
         },
-        {to: 'blog', label: 'Blog', position: 'left'},
         // Please keep GitHub link to the right for consistency.
         {
           href: 'https://github.com/mapillary/mapillary-python-sdk',
@@ -44,19 +48,6 @@ module.exports = {
     footer: {
       style: 'dark',
       links: [
-        {
-          title: 'Learn',
-          items: [
-            {
-              label: 'Style Guide',
-              to: 'docs/',
-            },
-            {
-              label: 'Second Doc',
-              to: 'docs/doc2',
-            },
-          ],
-        },
         {
           title: 'Community',
           items: [
@@ -77,12 +68,6 @@ module.exports = {
         {
           title: 'More',
           items: [
-            // Do we want to keep the SDK blog?
-              // For now, commented out
-            //   {
-            //   label: 'SDK Blog',
-            //   to: 'blog',
-            // },
             {
               label: 'Blog',
               href: 'https://blog.mapillary.com/',
@@ -163,12 +148,6 @@ module.exports = {
           // Please change this to your repo.
           editUrl: 'https://github.com/mapillary/mapillary-python-sdk/tree/main/docs',
         },
-        blog: {
-          showReadingTime: true,
-          // Please change this to your repo.
-          editUrl:
-            'https://github.com/mapillary/mapillary-python-sdk/tree/main/docs',
-        },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
         },

docs/src/pages/index.js

@@ -18,31 +18,31 @@ import styles from './styles.module.css';
 const features = [
   {
     title: 'Easy to Use',
-    imageUrl: 'img/undraw_docusaurus_mountain.svg',
+    // imageUrl: 'img/undraw_docusaurus_mountain.svg',
     description: (
       <>
-        Docusaurus was designed from the ground up to be easily installed and
-        used to get your website up and running quickly.
+        The SDK was designed from the ground up to be easily installed and
+        used to get geospatial data as easily as possible.
       </>
     ),
   },
   {
-    title: 'Focus on What Matters',
-    imageUrl: 'img/undraw_docusaurus_tree.svg',
+    title: 'Fully Featured',
+    // imageUrl: 'img/undraw_docusaurus_tree.svg',
     description: (
       <>
-        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
-        ahead and move your docs into the <code>docs</code> directory.
+        The SDK provides a focus on providing as much ease and utility to the users
+          as possible, and in helping users be power users if needed
       </>
     ),
   },
   {
-    title: 'Powered by React',
-    imageUrl: 'img/undraw_docusaurus_react.svg',
+    title: 'Powered by Python',
+    // imageUrl: 'img/undraw_docusaurus_react.svg',
     description: (
       <>
-        Extend or customize your website layout by reusing React. Docusaurus can
-        be extended while reusing the same header and footer.
+          Developed with an extensible and easy to use language, Python provides
+          easy to understand semantics for beginners and advanced users alike
       </>
     ),
   },
@@ -80,7 +80,7 @@ export default function Home() {
                 'button button--outline button--secondary button--lg',
                 styles.getStarted,
               )}
-              to={useBaseUrl('docs/')}>
+              to={useBaseUrl('docs/intro')}>
               Get Started
             </Link>
           </div>