domenic-mzs / essential-arscape

AR journey from day one! This repository chronicles my initial encounter and learning experiences with Augmented Reality tech since my first dive. Explore my discoveries, experiments, and foundational lessons as I step into the captivating world of AR for the first time.

💫 About Me:

🌍 I'm from Paraguay, in South America. I love being curious and creative and I believe technology can help to solve many problems if applied correctly. I'm (for the time being) a self taught developer and I'm eager to learn more from the open source community, and also currently working on getting a degree at the university of my dreams to empower technological solutions to change my country.

💡 Open to mentorship and collaboration on cool code projects, eager to explore growth opportunities.

🤔 Wanting help to get better at networking and learn tech.

📚 Currently diving into Extended Reality Technologies and learning about JSON-LD principles.

💬 Let's chat about live, culture, games or tech! Love trying out different ways to learn new things.

🌟 I'm passionate about what i do, and what a i can achieve!

💻 Tech Stack:

📊 GitHub Stats:

🏆 GitHub Trophies

✍️ Random Dev Quote

🔝 Top Contributed Repo

---

essential-arscape's Issues

Automate Pull Request Code Format Validations & Fixes with GitHub Actions

Is your feature request related to a problem? Please describe.
Whenever a pull request is made, if it was edited using Obsidian (preferably/probably), it will contain incompatible markdown styles that need fixing or changing before it's ready to go. GitHub doesn't render these properly. Additionally, there are specific naming conventions tied to the Obsidian graph system.

Describe the Solution You'd Like
I propose implementing a quick markdown style validation using GitHub's flavor of markdown to streamline the collaboration process. This specific check would make it easier and faster to:

• Identify incorrect filenames, such as missing README files or space-separated files.
• Identify incorrect paths in links and tags, such as paths referring to a local drive location like C:\path\to\file.md.

To achieve this, it's probably needed a RegExp to peek on every file and a script to automatically fix those issues if possible.

Describe Alternatives You've Considered
I've considered automating this process post-merge, but I believe a Pull Request validator would be a more robust solution.

Additional Context

• First Obsidian/Markdown PR Request describing the compatibility issues and editing experience.

Importance Summary List Displayed as Single Line in README's Section

Describe the Bug
There's a bug in the "Importance" section where the summarized list appears as a single line, making it exceedingly challenging to read and disrupting the natural flow.

To Reproduce
Steps to reproduce the behavior:

1. Navigate to /docs.
2. Open the README file.
3. Scroll down to the Importance section.
4. Observe the importance summary list displayed as a single line.

Expected Behavior
The expected behavior is a pleasant reading experience with a list that is easy to read, presented in a stacked format.

Screenshots

Additional Context

• No additional context

README Enhancements with more Markdown, GIFs and Emojis 😃 📝✨

README Enhancements with more Markdown, GIFs and Emojis 😃 📝✨

Describe the Issue

The current README files lack engaging elements and navigational aids, making them less user-friendly and visually appealing. 🙁

Suggested Improvement

Introduce special Markdown elements such as tables, code blocks, and headers to organize content better. Incorporate emojis to add visual context and enhance readability. Additionally, implement link sections for easier navigation within the README files. 🚀🔍🎨

Additional Context

A lot of text! We need more GIFs, Emojis, and Special Markdown in our lives :P

Example Changes:

• Use tables to present information on usage or installation steps. 📊
• Incorporate code blocks for clearer code snippets. 💻
• Utilize headers and formatting to break down sections for easier comprehension. 🗂️
• Add relevant emojis to highlight key points or sections. 🌟
• Implement link sections to enable swift navigation within the document. 🔗

This enhancement aims to elevate the user experience and provide clearer, more engaging documentation. 🚀

Note: Contributions and suggestions are welcome! Feel free to add thoughts or specific suggestions on how to improve the READMEs. 🌈✨

Improving Documentation for Obsidian Integration

Describe the Issue
The current documentation lacks comprehensive guidance on utilizing Obsidian for project-related tasks, including compatibility, formats, and essential scripts needed for seamless integration and collaboration.

Suggested Improvement

1. Compatibility and Requirements:

   • Clarify Obsidian's compatibility with the project files and markdown formats. Detail the supported versions and potential compatibility issues to anticipate.
   • List the necessary system requirements and dependencies to effectively use Obsidian within the project's environment.

2. Setup Instructions:

   • Provide step-by-step instructions on setting up Obsidian to work seamlessly with the project files. Include guidance on installation, configurations, and any required plugins or settings for optimal functionality.
   • Explain any specific folder structures or organizational tips to ensure a smoother workflow between the project and Obsidian.

3. Markdown Formats and Styling:

   • Detail preferred markdown formats, styles, and conventions to maintain consistency between Obsidian and the project files. Highlight any differences or recommended practices for smoother editing and readability.
   • Provide guidelines on using Obsidian-specific features (e.g., backlinks, graph view) to enhance navigation and understanding within the project documentation.

4. Integration with Scripts or Automation:

   • Outline any scripts, tools, or automation methods that streamline the synchronization or interaction between Obsidian and the project's version control system (if applicable). Include any recommended workflows or best practices.

Additional Context

• Automated Code Format Validations & Fixes

Creating the Inaugural Detailed Roadmap for Clear Project Direction

Creating the Inaugural Detailed Roadmap for Clear Project Direction

Is your feature request related to a problem? Please describe.

There is a lack of clarity regarding the project's direction and key milestones. We're facing challenges in establishing a clear and effective progress structure.

Describe the Solution You'd Like

We need to develop a detailed Roadmap that clearly defines the project scope, major milestones, and development phases. This will provide a step-by-step guide to follow during the project development process.

Describe Alternatives You've Considered

We've considered creating a broad plan without a detailed structure, but this might lead to a lack of clarity and direction in the project. We also contemplated relying on a more flexible planning, but we believe a detailed Roadmap will be more beneficial for the team and project.

Additional Context

Our main goal is to ensure that everyone involved in the project clearly understands the goals, stages, and key timelines. This will help align expectations and provide a clear roadmap for the project to develop.

---

Todo List:

• Define Objectives and Goals: Identify the overarching goals and objectives of the project. What is the aim to achieve, and what outcomes are expected?

• Gather Requirements and Resources: List the necessary resources, including tools and technologies required to accomplish the project objectives.

• Create a Timeline: Develop a rough timeline that outlines milestones, key deliverables, and deadlines.

• Breakdown Tasks: Divide the project into smaller, manageable tasks. Ensuring each task aligns with the project's goals and vision.

• Prioritize Tasks: Determine task dependencies and prioritize them based on critical paths. Identifying which tasks must be completed before others can start first.

• Establish Milestones: Define specific checkpoints or milestones to track progress. These should be significant achievements within the project's timeline.

• Set Realistic Timelines: Ensure that the timeline is feasible and realistic. Consider potential risks and allocate buffer time for unforeseen challenges with a considerable error margin.

Key Notes:

• Keep it Visual: Visual aids like charts, graphs, or infographics can make the roadmap more understandable and accessible for everyone.
• Stay Agile: Adjustments will be needed. Flexibility and Adaptation are important.
• Regular Updates: Update the roadmap regularly as needed to reflect progress, changes, or any shifts in priorities.

Extended Reality (XR) Fundamentals

Is your feature request related to a problem? Please describe.
This issue aims to add base documentation files for Extended Reality (XR) fundamental areas, background and concepts.

Describe the Solution You'd Like

• Definition of Extended Reality (XR)
• Extended Reality Areas
• Understanding User Interaction
• Importance of Extended Reality (XR) and it's current state of development in the market
• Extended Reality Programs and background

Additional Context

• #3

Include Gitignore Entries for Obsidian

Enhancement Request: Include Gitignore Entries for Obsidian

Is your feature request related to a problem? Please describe.

Currently, Git repositories may include Obsidian-related files that aren't necessary to track or could potentially clutter version control.

Describe the Solution You'd Like

Add specific Gitignore entries tailored for Obsidian to exclude unnecessary files (like cache, temporary, or settings files) from being included in version control.

Describe Alternatives You've Considered

Manually adding Obsidian-related file paths to the .gitignore file, but a preconfigured set of ignore patterns for Obsidian would streamline the process.

Additional Context

Some Obsidian-specific files, such as cache or workspace settings, might not need to be tracked in version control. Having default Gitignore entries for these would enhance repository cleanliness and management.