Update docs with new release

0xquantum3labs commented 3 months ago

Issue Overview

Based on latest release udpate docs.

Proposed Solutions or Ideas

check new features and update docs

raizo07 commented 3 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello I'll like to work on this. I'm a fullstack dev and i've worked on the the documentation for a couple of projects on Starknet like Starknet docs, Unruggable meme, StrkFarm and a host of others.

onlydustapp[bot] commented 3 months ago

Hey @raizo07! Thanks for showing interest. We've created an application for you to contribute to Speedrun & Scaffold Stark. Go check it out on OnlyDust!

Iwueseiter commented 3 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi @0xquantum3labs can I work on this please? I already left a comment on the issue before it got moved to docs. I've wrtten documetation via onlydust before and with that experience, I will update the documentation to cover the new features.

How I plan on tackling this issue

I'd go through the new features with the link you provided and write a comprehensive docs that's up to standard.

onlydustapp[bot] commented 3 months ago

Hey @Iwueseiter! Thanks for showing interest. We've created an application for you to contribute to Speedrun & Scaffold Stark. Go check it out on OnlyDust!

LazarusAA commented 3 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi, I'd love to work on this issue. I'm really into documentation and I believe this is an ideal first issue to begin my journey with OnlyDust. It would be a pleasure to contribute to this project, and I look forward to hearing back from you.

Best regards, Lazarus

juandiegocv27 commented 3 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm Juan Diego Carballo, a Full-Stack Web Developer with extensive experience in Rust, Python, and blockchain development technologies. I am currently enhancing my skills through active participation in projects and programs within this ecosystem. I am excited to contribute to the ss2-docs project by updating the documentation to reflect the latest release.

How I plan on tackling this issue

-Feature Review: I will thoroughly review the new features introduced in the latest release, ensuring I fully understand the changes and enhancements. -Documentation Update: I will update the existing documents to incorporate the new features, ensuring that all information is current and accurately reflects the latest functionalities. -Quality Assurance: I will review the updated documentation for clarity, accuracy, and completeness, ensuring it meets the high standards expected by users and contributors.

I am ready to begin work on this as soon as possible and look forward to making a meaningful contribution to the ss2-docs project.

ShantelPeters commented 3 months ago

I am applying to the issue OnlyDust platform. Background and Leverage: As a technical writer with experience in creating user-friendly documentation, I'm excited to help update the docs based on the latest release. My background in software development and documentation has equipped me with the skills to understand complex technical concepts and communicate them effectively.

Approach to the Problem:

Review Release Notes: I'll thoroughly review the latest release notes to identify new features, updates, and changes.
Update Documentation: I'll update the existing documentation to reflect the new features, ensuring clarity, accuracy, and consistency.
Create New Content: I'll create new content, such as tutorials, guides, or reference materials, to cover the updated features.
Verify Accuracy: I'll verify the accuracy of the updated documentation by testing the new features and consulting with subject matter experts.
Improve User Experience: I'll improve the overall user experience by reorganizing content, adding visuals, and enhancing navigation.

Solution: My proposed solution involves a thorough review of the release notes, updating existing documentation, creating new content, verifying accuracy, and improving user experience.

Technical Details:

I'll use markdown or other documentation tools to update the docs.
I'll utilize version control systems like Git to track changes and collaborate with others.
I'll ensure the updated docs are optimized for search engines and accessibility.

Jayse007 commented 3 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a backend developer and having worked with documentation I believe I am the right fit for the job.

How I plan on tackling this issue

I would read the new features and requirements. Based on the updates I would make accurate and non-ambiguous updates to the docs

ScottyDavies commented 3 months ago

i am applying or this issue via OnlyDust platform.

Assess the Current Implementation: Understand how the application currently integrates with DaisyUI and the vanilla implementations. Identify areas where the UI library integration is tightly coupled or hardcoded. Design a Flexible UI Library Integration: Create an abstraction layer or UI library adapter to encapsulate the integration logic for different UI libraries. Provide a consistent API for components, styles, and functionalities, allowing the application to interact with the UI library in a standardized way. Implement the Adapter Pattern: Define adapter interfaces that specify the contract for UI library integration. Implement concrete adapters for each supported UI library (e.g., DaisyUI, Material UI, Ant Design). Ensure the adapters handle differences in component APIs, styling, and functionality across libraries. Update the Application Code: Refactor the existing codebase to use the UI library adapter interfaces instead of directly interacting with the underlying UI library. Provide a mechanism (e.g., configuration, dependency injection) to allow users to specify the desired UI library at runtime. Enhance the Documentation: Update the project's documentation to explain the UI library integration approach and how users can select the desired UI library. Provide examples and guides for integrating different UI libraries with the application. Add a FAQ section to address common questions and concerns related to the UI library integration. Implement a Smooth Migration Path: Ensure the existing DaisyUI-based components and functionality can be easily migrated to the new UI library adapter-based implementation. Provide a gradual migration path, allowing users to transition to the new UI library integration at their own pace. Test the Integration: Create comprehensive tests to ensure the UI library adapter-based implementation works as expected, focusing on component rendering, functionality, and styling. Validate the integration with various UI libraries to ensure consistency and correctness. As an experienced frontend developer, I can leverage the following skills and knowledge to address this issue:

UI library integration expertise: I have experience integrating diverse UI libraries into applications and can apply best practices for creating a flexible and extensible integration. Design patterns knowledge: I can apply the Adapter pattern to encapsulate the UI library integration logic and provide a consistent API. Strong testing skills: I can create thorough unit and integration tests to ensure the UI library integration works as expected. Documentation and user experience: I can enhance the project's documentation and provide clear guidance for users on integrating their preferred UI library. Agile development practices: I can work iteratively, prioritizing critical aspects and ensuring a smooth migration path for existing users. By addressing this issue, I can help make the project more flexible, extensible, and user-friendly, benefiting a wider range of developers and users.

PoulavBhowmick03 commented 3 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a fullstack blockchain developer with 1 year of experience

How I plan on tackling this issue

I will go through the update docs, check for new features and changes to be made and make those changes in the docs

DavidOredu commented 3 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm a C# programmer specializing in Unity game development. I have also have experience with Python can understand and can discern intended logic with proposed algorithms.

How I plan on tackling this issue

I intend to determine new features by looking at the time of the latest update, then make summary based on the logic in the programming of the updates, then update these findings on a readme.

oceanlvr commented 3 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

im good at javascript & typescript. im graduated from East China Normal University. Computer Science & engineering.

How I plan on tackling this issue

solve this issue till this week

oceanlvr commented 2 months ago

hello sir, im writing the latest doc. (issue https://github.com/Quantum3-Labs/ss2-docs/issues/5)

I compare the code from 0.1.0 to 0.2.0 https://github.com/Quantum3-Labs/scaffold-stark-2/compare/v0.1.0...v0.2.0

It seems that we have only updated the support of the if component under the debug page, mainly these features New Features

Support for Arrays of Structs: Added support on /debug for handling arrays of structs.
Support for Complex Types: Enhanced /debug page to handle complex types like nested structs and nested tuples with Enums and Arrays / Spans
Faster Deployment Script: Improved deployment scripts to allow for single transaction deployment of multiple contracts.

so In which part of the documentation page should we place the features supported by arrays such as arrays on the debug page? How to give users a better perception? We have updated the components of the debug page.

Scaffold-Stark / ss2-docs