Merge pull request #1 from dat-adi/main

docs: Landing page and Logo Update

config.toml

@@ -8,6 +8,6 @@ highlight_code = true
 highlight_theme = "base16-ocean-light"
 
 [extra]
-logo = "https://easydocs.codeandmedia.com/logo.svg"
+logo = "/logo.svg"
 release = "https://api.github.com/repos/getzola/zola/releases/latest"
 favicon = "https://www.getzola.org/favicon.ico"

content/_index.md

@@ -3,43 +3,48 @@ title = "Magic Bridges"
 insert_anchor_links = "right"
 +++
 
-# ForgeFlux
+## A day of the past
 
-[ForgeFlux](https://forgeflux.org/) aims to implement federation in [software forges](https://en.wikipedia.org/wiki/Forge_(software)) , enabling
-a decentralized development environment.
+It's a Friday evening, and you've sat down to work on some code and halfway through
+testing the code, you realise that there's a problem with a dependency.
+Something's not supposed to work the way it does, and you hop on to the code-hosting
+platform, or forge, that you use on a daily basis to search for the library.
+Realizing that the project is not quite hosted on your forge, you close your eyes,
+before reluctantly heading over to a search engine, to find the project repository
+being hosted on another forge that you haven't worked with.
 
-## Why is this significant?
-There have been numerous forges that have popped 
-up over the course of time.
-Each of these forges have their own community base,
-and projects that are associated to the forge itself.
+At this point, in order to file a bug report, or even send a Pull Request that could
+fix the issue, you would be required to create an account on the forge and clone the
+repository and relearn the workings of the particular forge before finally working
+on the code.
+Manually tracking notifications, setting up new remotes for the upstreams,
+configuring GPG and SSH keys, and having to set up a new development workflow.
 
-However, issues arise when a user wishes to contribute towards
-a project that exists in another forge.
-This would require them to charter into unknown forge territory,
-to have to relearn the functionality that they're already at home with.
+The evening prolongs into the night, and you're finally ready with that PR, which
+you had to learn a new forge for.
 
-ForgeFlux, is an idea, that intends to get rid this problem.
-Work on your own forge, but **bridge** the project.
+## A day of the future
 
-Bridging a project would allow for a user to contribute towards projects that 
-exist in foreign forges, through the comfort of their own forge.
+Worrying about the forge-specific operations that you'll need to perform are a thing of
+the past now. With the inclusion of a bridging feature in your code-hosting platform,
+you can finally forget about how other forges behave and whether you'll need to work
+towards creating a new account to contribute.
+A contribution, be it a Bug Report, Feature Request, or a Pull Request, now can be
+solved through setting up a bridge to the repository you want to contribute to.
 
-## Has this been done before?
+Days are pleasant and you can continue working on your code after you're done with the
+issue of the library.
+You check out and have more time for things that you wanted to work on for the rest of
+the day.
 
-The initial [forgefed](https://forgefed.peers.community/) was 
-an attempt to bridge this gap, by introducing the concept 
-of bridging the gap between forges.
-This approach required for the forge developers to actively 
-participate in the development of the software.
+## Enter ForgeFlux
 
-The present ForgeFlux, focuses on the implementation being present 
-in the API space instead.
-This reduces the interference required on the side of the forges themselves,
-and seeks to develop on existing utility and APIs provided.
+While the days of the past are what we live in currently, ForgeFlux is the intermediary
+that seeks to get developers to the days of the future!
 
-ForgeFlux, consists of a terminology for the development and 
-utilization of it's software, which result in terms such as `forges`,
-and `interfaces` being tossed around.
-It is recommended for a reader to go through the [ecosystem-architecture](https://github.com/forgeflux-org/spec/blob/master/rfc/1-ecosystem-architecture/1-ecosystem-architecture.md), if there is any confusion regarding the usage of particular words in this documentation.
+Implementing bridging leveraging the API space, [Northstar](@/services/northstar.md)
+points, and the [Interface](@/services/interface.md) sets it all up.
+Know more about how ForgeFlux works [here!](@/getting-started/how.md)
 
+We're currently still in active development, and you can check what we've been
+working on, in the `updates/` section.

content/getting-started/how.md

@@ -0,0 +1,43 @@
++++
+title = "How does it work?"
+weight = 40
++++
+
+# How does it work?
+
+Bridges connect people, and so does ForgeFlux!
+
+## Interface
+
+The bridging component in ForgeFlux is called Interface.
+
+[Interfaces](@/services/interface.md) are programs that run on either
+side of the bridge, i.e, a bridge requires the participation of two
+interfaces. Currently, Interfaces bridge the following operations:
+
+-   Pull Requests
+-   Issues
+-   Comments
+
+An Interface implementation for a software forge is able to
+talk to the forge's API and speak [ActivityPub
+protocol](https://activitypub.rocks/) for server-to-server
+communications. This architecture makes it possible to implement an
+Interface for any forge setup.
+
+## Northstar
+
+Since Interfaces run external to the forges, a method to find Interfaces
+that service forges was required.
+
+[Northstar](@/services/northstar.md) is a discovery service that maps an
+Interface and the forge that it services. It acts very similar to DNS,
+except instead of querying host names with intent to find corresponding
+IP address, Northstar is queried with the forge's host name to discover
+the Interfaces that service it.
+
+## Resources
+
+-
+  [ecosystem-architecture](https://github.com/forgeflux-org/spec/blob/master/rfc/1-ecosystem-architecture/1-ecosystem-architecture.md):
+  describes basic architecture and terminology used in ForgeFlux

content/getting-started/intro.md

@@ -1,21 +0,0 @@
-+++
-title = "How does it work?"
-weight = 40
-+++
-
-# How does it work?
-Interfaces are services that are run on the side of any user, and are used as connecting points of the bridge.
-These interfaces are responsible for communicating with each other, and interact in the form of messages for a server-server model, and a REST API model for the server-user model.
-
-Interfaces are geared towards performing various operations for the repository, which include but are not limited to,
-- Pull Requests
-- Issues
-- Comments
-- Notifications
-- Forking
-
-However, as the count for interfaces go up in magnitudes, it becomes increasingly hard to keep track of them.
-This is where Northstar comes to play, by implementing a lookup server that seeks to provide an indexed list of available forge interfaces.
-
-ForgeFlux is currently in the Active Development phase, and is being worked on towards the alpha-testing stage.
-

static/logo.svg

@@ -1 +1 @@
-<svg id="logo-11" width="119" height="30" viewBox="0 0 119 30" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M2.94098 27.825H28.591V2.175H2.94098V27.825ZM23.654 12.532H18.234V7.112H23.654V12.532ZM7.87698 7.112H13.3V17.468H23.654V22.888H7.87698V7.112ZM45.294 2.175C42.7574 2.175 40.2778 2.92718 38.1688 4.33641C36.0597 5.74564 34.4159 7.74863 33.4452 10.0921C32.4745 12.4356 32.2206 15.0142 32.7154 17.502C33.2103 19.9898 34.4317 22.275 36.2253 24.0686C38.0189 25.8623 40.3041 27.0837 42.7919 27.5786C45.2798 28.0734 47.8584 27.8195 50.2019 26.8488C52.5454 25.8781 54.5483 24.2343 55.9576 22.1252C57.3668 20.0161 58.119 17.5365 58.119 15C58.115 11.5998 56.7625 8.34004 54.3582 5.93575C51.9539 3.53145 48.6942 2.17897 45.294 2.175V2.175ZM45.294 22.888C43.7339 22.888 42.2088 22.4254 40.9116 21.5586C39.6145 20.6919 38.6034 19.46 38.0064 18.0186C37.4094 16.5773 37.2532 14.9913 37.5575 13.4611C37.8619 11.931 38.6132 10.5255 39.7163 9.42234C40.8195 8.31919 42.225 7.56793 43.7551 7.26357C45.2852 6.95921 46.8712 7.11542 48.3126 7.71244C49.7539 8.30946 50.9859 9.32049 51.8526 10.6177C52.7194 11.9148 53.182 13.4399 53.182 15C53.1788 17.0911 52.3467 19.0956 50.8681 20.5742C49.3895 22.0528 47.385 22.8848 45.294 22.888V22.888ZM104.013 2.175C101.476 2.17481 98.9967 2.92681 96.8875 4.33592C94.7783 5.74503 93.1344 7.74795 92.1635 10.0914C91.1927 12.4348 90.9385 15.0136 91.4333 17.5014C91.928 19.9893 93.1494 22.2746 94.943 24.0683C96.7365 25.862 99.0217 27.0836 101.51 27.5785C103.997 28.0734 106.576 27.8195 108.92 26.8489C111.263 25.8782 113.266 24.2344 114.675 22.1253C116.085 20.0162 116.837 17.5366 116.837 15C116.833 11.6 115.481 8.34036 113.077 5.9361C110.673 3.53183 107.413 2.17924 104.013 2.175V2.175ZM104.013 22.888C102.453 22.8882 100.928 22.4257 99.6304 21.5591C98.3331 20.6925 97.3219 19.4606 96.7247 18.0193C96.1275 16.578 95.9712 14.9919 96.2754 13.4617C96.5797 11.9316 97.3309 10.526 98.434 9.4227C99.5371 8.31944 100.943 7.56808 102.473 7.26364C104.003 6.9592 105.589 7.11535 107.03 7.71235C108.472 8.30934 109.704 9.32036 110.571 10.6176C111.437 11.9148 111.9 13.4399 111.9 15C111.897 17.0909 111.065 19.0952 109.586 20.5738C108.108 22.0524 106.104 22.8846 104.013 22.888V22.888ZM74.653 2.175C72.1164 2.175 69.6368 2.92718 67.5278 4.33641C65.4187 5.74564 63.7749 7.74863 62.8042 10.0921C61.8335 12.4356 61.5796 15.0142 62.0744 17.502C62.5693 19.9898 63.7907 22.275 65.5843 24.0686C67.3779 25.8623 69.6631 27.0837 72.1509 27.5786C74.6387 28.0734 77.2174 27.8195 79.5609 26.8488C81.9044 25.8781 83.9073 24.2343 85.3166 22.1252C86.7258 20.0161 87.478 17.5365 87.478 15C87.474 11.5998 86.1215 8.34004 83.7172 5.93575C81.3129 3.53145 78.0532 2.17897 74.653 2.175ZM74.653 22.888C73.1994 22.8887 71.774 22.4878 70.5339 21.7295C69.2939 20.9712 68.2874 19.8851 67.6257 18.5909C66.9641 17.2967 66.6728 15.8448 66.7842 14.3956C66.8956 12.9463 67.4052 11.556 68.2569 10.3781C69.1086 9.20026 70.2692 8.28061 71.6105 7.72071C72.9519 7.1608 74.4219 6.98242 75.8582 7.20524C77.2946 7.42807 78.6414 8.04343 79.7501 8.98342C80.8588 9.9234 81.6862 11.1515 82.141 12.532H74.653V17.468H82.141C81.6201 19.0433 80.6165 20.4147 79.2724 21.3875C77.9284 22.3604 76.3122 22.8853 74.653 22.888V22.888Z" class="ccustom" fill="#394149"></path> </svg>
+<svg id="a45af197-b8b6-4c91-9128-4abb56b81e95" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 372.66 53.32"><defs><style>.a95b92e2-21b6-4941-aebf-1e24593560e5{fill:#ee362d;}.b31c35f1-b68c-4767-9b42-fc6f08b15844{fill:#6d6f6e;}.b010529f-8534-4670-9bfc-0c669400821a{fill:#6d6e70;}</style></defs><rect class="a95b92e2-21b6-4941-aebf-1e24593560e5" x="5.74" y="2.85" width="38.79" height="10.38" rx="1.94"/><rect class="a95b92e2-21b6-4941-aebf-1e24593560e5" x="5.74" y="21.55" width="24.59" height="10.38" rx="1.94"/><rect class="b31c35f1-b68c-4767-9b42-fc6f08b15844" x="40.61" y="21.55" width="24.59" height="10.38" rx="1.94"/><rect class="a95b92e2-21b6-4941-aebf-1e24593560e5" x="5.74" y="40.09" width="10.38" height="10.38" rx="1.94"/><rect class="b31c35f1-b68c-4767-9b42-fc6f08b15844" x="54.83" y="2.85" width="10.38" height="10.38" rx="1.94"/><rect class="b31c35f1-b68c-4767-9b42-fc6f08b15844" x="26.42" y="40.09" width="38.79" height="10.38" rx="1.94"/><path class="a95b92e2-21b6-4941-aebf-1e24593560e5" d="M89.68,14.18V27.41h19v4.66h-19V47.42H84.26v-38h26.79v4.72Z"/><path class="a95b92e2-21b6-4941-aebf-1e24593560e5" d="M115.75,33.22c0-8.4,6.6-14.6,15.45-14.6s15.45,6.2,15.45,14.6-6.55,14.6-15.45,14.6S115.75,41.62,115.75,33.22Zm26,0a10.55,10.55,0,0,0-21.1,0,10.55,10.55,0,0,0,21.1,0Z"/><path class="a95b92e2-21b6-4941-aebf-1e24593560e5" d="M173.2,47.42l-6.1-8.5a10.87,10.87,0,0,1-1.3,0h-6.75v8.45H154.2V19h11.6C173.25,19,178,22.67,178,29a9.09,9.09,0,0,1-6.25,9l6.75,9.4ZM173.05,29c0-3.85-2.6-6-7.55-6h-6.45V35h6.45C170.45,35,173.05,32.87,173.05,29Z"/><path class="a95b92e2-21b6-4941-aebf-1e24593560e5" d="M205.46,33.07h4.7v11.1a17.2,17.2,0,0,1-10.95,3.65c-9.05,0-15.65-6.2-15.65-14.6s6.6-14.6,15.45-14.6c5,0,8.8,1.45,11.45,4.45l-3.1,3.15a10.87,10.87,0,0,0-8.25-3.4c-6.15,0-10.65,4.35-10.65,10.4s4.5,10.4,10.8,10.4a11.58,11.58,0,0,0,6.2-1.6Z"/><path class="a95b92e2-21b6-4941-aebf-1e24593560e5" d="M240.71,43.37v4.05h-21.3V19h20.75v4h-15.9v8h14.15V35H224.26v8.4Z"/><path class="b010529f-8534-4670-9bfc-0c669400821a" d="M254.69,14.18V27.41h19v4.66h-19V47.42h-5.43v-38h26.79v4.72Z"/><path class="b010529f-8534-4670-9bfc-0c669400821a" d="M283.4,19h4.85V43.37H303.5v4.05H283.4Z"/><path class="b010529f-8534-4670-9bfc-0c669400821a" d="M308.35,35.27V19h4.85V35.17c0,5.55,2.7,8.45,7.65,8.45s7.65-2.85,7.65-8.45V19h4.76V35.27c0,7.95-4.66,12.55-12.46,12.55S308.35,43.22,308.35,35.27Z"/><path class="b010529f-8534-4670-9bfc-0c669400821a" d="M360.16,47.42l-8.05-11-8.15,11h-5.55l11-14.55L339.06,19h5.45l7.65,10.3,7.6-10.3h5.4l-10.35,13.8,10.95,14.6Z"/></svg>