Docs homepage enhancement #5161
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,50 @@ | ||
| # Welcome to Terasology! | ||
|
|
||
| 🌟 **Embark on an open-source adventure** where you can contribute, play, and explore the world of Terasology. | ||
|
|
||
| Discover a diverse range of Terasology resources within this wiki, encompassing various aspects of the game. For detailed game content, comprehensive gameplay guidance, developer resources, and dedicated information on related topics, navigate to specific sections provided here. | ||
|
|
||
| ## Quick Links | ||
|
|
||
| - **[🎮 Players](https://github.com/MovingBlocks/Terasology/blob/develop/docs-pre-merge/Playing.md)** - For Players | ||
| - **[🏗️ Developer's Hub](Contributor-Quick-Start.md)** - For Developers | ||
| - **[🛠️ Maintainer's Dashboard](Maintenance.md)** - For Maintainers | ||
|
|
||
|
|
||
|
|
||
| ## Understanding Terasology | ||
|
|
||
| Terasology itself is a pure sandbox. Gameplay is implemented through modules, which can add anything from new blocks and crafting methods to entirely new game modes. | ||
|
|
||
| - 🏛️ **[Architecture Overview](Codebase-Structure.md)** | ||
| - Understand the high-level structure of the project. | ||
| - 🔧 **[Entity System Architecture](Entity-System-Architecture.md)** | ||
| - Dive into how our entity system powers the game. | ||
| - 🎲 **[Events and Systems](Events-and-Systems.md)** | ||
| - Explore how to inject new logic and life into the game. | ||
| - 🏗️ **[Block Architecture](https://github.com/Terasology/TutorialAssetSystem/wiki/Block-Attributes)** | ||
| - Delve into the building blocks of the game world. | ||
|
|
||
| ## Core and Libraries | ||
| - This core is backed by several in-house libraries, such as [MovingBlocks/gestalt](https://github.com/MovingBlocks/gestalt), providing the entity system and module management, or our own UI library [MovingBlocks/TeraNUI](https://github.com/MovingBlocks/TeraNUI). | ||
| - The actual game content is added by modules on top of that. | ||
|
|
||
|
|
||
| ### Getting Help and Support | ||
|
|
||
| - If you believe you've found a bug, please create an issue on GitHub [open an issue on GitHub](https://github.com/MovingBlocks/Terasology/issues/new/choose). | ||
|
|
||
|
There was a problem hiding this comment. The information removed here is somewhat important. Are you planning to reintroduce it somewhere else? There was a problem hiding this comment. i we add it back to the home page and figured out the right positioning for it |
||
|
|
||
| ## Troubleshooting | ||
|
|
||
| Encountering issues? Our [Troubleshooting guide](Troubleshooting.md) offers solutions for common problems faced by players and developers alike. | ||
|
|
||
| ## Announcement Channels | ||
|
|
||
| - **[Discord](https://discordapp.com/invite/terasology)** - for discussion and general support. | ||
| - **[GitHub (Engine)](https://github.com/MovingBlocks/Terasology)** - Watch the engine or modules for real-time updates. | ||
| - **[GitHub (Modules)](https://github.com/Terasology)** - Watch the module repos for game content fixes / changes. | ||
| - **[Forum](http://forum.terasology.org/)** - Find the progress reports of ongoing and past GSoC projects | ||
| - **[Twitter](http://twitter.com/#!/Terasology)** - Follow for tweet-sized news. | ||
| - **[Facebook](http://www.facebook.com/pages/Terasology/248329655219905)** - Like us for updates in your feed. | ||
| - **[Jenkins RSS](http://jenkins.terasology.io/rssAll)** - For the keen observers of new builds. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,59 +1,69 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <title>Terasology - Knowledge Base</title> | ||
| <link rel="stylesheet" href="styles.css" /> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> | ||
| <meta | ||
| name="google-site-verification" | ||
| content="AEyBzDSx59v83eaRwdY3ghuYBa4g072fzgMdtQiCCn8" | ||
|
Comment on lines
+8
to
+10
There was a problem hiding this comment. I know that this predates your changes but does anyone recall what this is for? There was a problem hiding this comment. I have no idea about what it is, but when I just checked, this is what it means [The "google-site-verification" meta tag is used to confirm that you have access to the website's backend and can make changes to its code.] |
||
| /> | ||
| <meta | ||
| name="description" | ||
| content="An open source voxel game - imagine the possibilities!" | ||
| /> | ||
| <meta | ||
| name="viewport" | ||
| content="width=device-width, initial-scale=1.0, minimum-scale=1.0" | ||
| /> | ||
| <link | ||
| rel="stylesheet" | ||
| href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css" | ||
| /> | ||
| </head> | ||
|
|
||
| <body> | ||
| <div id="app"></div> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify-edit-on-github"></script> | ||
| <script> | ||
| window.$docsify = { | ||
| name: "Terasology", | ||
| repo: "MovingBlocks/Terasology", | ||
| logo: "/images/terasology-logo.png", | ||
|
There was a problem hiding this comment. The icon in the sidebar appears a bit too tall, in my opinion. It displaces the start of the content almost a third of the way down the page. There was a problem hiding this comment. the sidebar icon can be reduced to any size. just let me know the actual width and height. There was a problem hiding this comment. I wouldn't go with fix width and height but with a percentage if possible. |
||
| themeColor: "#08A045", | ||
| loadSidebar: true, | ||
| autoHeader: true, | ||
| search: "auto", | ||
| //homepage: 'https://raw.githubusercontent.com/MovingBlocks/Terasology/develop/README.md', | ||
| homepage: "Home.md", | ||
| pagination: { | ||
| crossChapter: true, | ||
| crossChapterText: true, | ||
| }, | ||
| plugins: [ | ||
| EditOnGithubPlugin.create( | ||
| "https://github.com/MovingBlocks/Terasology/tree/develop/docs/" | ||
| ), | ||
| // function (hook) { | ||
| // // this "fixes" the relative links in the README which is loaded from remote (see 'homepage' above) | ||
| // hook.beforeEach(function (content) { | ||
| // return content | ||
| // .replace(new RegExp("https://raw.githubusercontent.com/MovingBlocks/Terasology/develop/docs/"), "") | ||
| // .replace(new RegExp("./docs/"), ""); | ||
| // }) | ||
| // } | ||
| ], | ||
| }; | ||
| </script> | ||
| <!-- Docsify v4 --> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify@4"></script> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script> | ||
|
|
||
| <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-json.min.js"></script> | ||
| <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-json5.min.js"></script> | ||
| <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-java.min.js"></script> | ||
| </body> | ||
| </html> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| .app-name img { | ||
| max-width: 70%; | ||
| height: auto; | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like this "home" page should be the split-off point to the "hubs" for the different audiences (players, devs, maintainers), similar to how we did it in http://terasology.org/Terasology/#/Troubleshooting
Also, I feel like this page is very very long - ideally I would imagine it as the jump-off point into the dedicated hubs + some references to the most important links to get additional help (community/support), which btw I think are duplicated in "Community and Support", "Getting Help", "Troubleshooting", and "Stay Updated & Reach Out"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are right about making the homepage split-off point to the "hubs" for different audiences. What about the quick links section? It can cover different audience, and regarding the duplicates, we can have "Getting Help and Support," which refer to opening an issue in GitHub, and "Troubleshooting," which refer to the troubleshooting guide. The Announcement Channels remain the same.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can keep some quick links on the "home" page, yes, but we should consider what would be relevant for all audiences to get direct access to. I think troubleshooting, opening an issue, and maybe a link to our discord server might be reasonable candidates. any further ideas?