[DOC] Reusable moving forward component

[PiVortex]

What?

In many docs we have a "moving forward section" that often talks about where people can get support. This section should be easily updated in a single are that can then be propagated across docs.

Why?

To improve maintainability of our docs and increase visibility of our support

Acceptance Criteria

Tasks

Beta Give feedback

1. Identify pages that should & should not have this content
2. Determine the content that we want at the end of each section for devs to get help
3. Update / create a new section that will be used and should be in one single location

Resources

• Example https://docs.near.org/build/web3-apps/quickstart#moving-forward

[goffxnca]

i'm interested in working on this, could you assign it to me?

saw you mentioned this section should be easy to update in one spot, but looks like there are a few variations across different pages. maybe could craft a single standard texts or paragraph for this section and use it as a component? happy to build it out!

page1:

Moving Forward
That's it for our quickstart tutorial. You have now seen a fully functional frontend that can talk with NEAR contracts and render Web3 components.

If you have any questions, do not hesitate in joining us on Telegram or Discord. We regularly host Office Hours, in which you can join our voice channel and ask questions.

Happy coding!

page2

Moving Forward
A nice way to learn is by trying to expand a contract. Modify the cross contract example to use the guest-book contract!. In this way, you can try to make a cross-contract call that attaches money. Remember to correctly handle the callback, and to return the money to the user in case of error.

page3

Moving Forward
A nice way to learn is by trying to expand a contract. You can modify the guestbook example to incorporate a feature where users can give likes to messages. Additionally, implement a method to toggle the like.

page4

Moving Forward
A nice way to learn is by trying to expand the contract. Modify it by adding a parameter to increment and decrement, so the user can choose by how much to change the value. For this, you will need to use knowledge from the anatomy and storage sections.

page5:

Moving Forward
A nice way to learn is by trying to expand a contract. Modify the donation example so it accumulates the tokens in the contract instead of sending it immediately. Then, make a method that only the beneficiary can call to retrieve the tokens.

page6:

Moving Forward
That's it for the quickstart tutorial. You have now seen an open-source AI agent interacting with NEAR and controlling a wallet to make transactions.

To better understand how it works, check the agent.py file and the Function Calling explanation on HuggingFace.

A lot of things could be built by leveraging this PoC, some ideas could be:

A chatbot integrated to the explorer to summarize transactions directly in the page
Interactive tutorials in the documentation through a chatbot
"How to create an NFT?"
Multiple chats with explanations and code to complete given by the AI
In the end, the AI publish the smart contract, mint an NFT and send it to you on testnet
An AI trader reacting to on-chain or off-chain events to buy/sell some tokens with its wallet
The only limit is your imagination!
Happy coding! 🚀

page7

Moving Forward
That's it for the quickstart tutorial. You have now seen a fully functional contract with a minimal user interface and testing.

To better understand the contract's structure, check our contract's anatomy page.

If you prefer to see more examples, check our examples page.

Do not hesitate to reach out on Discord with any questions you have. We regularly host Office Hours, in which you can join our voice channel and ask questions.

Happy coding! 🚀

[gagdiez]

Hi @goffxnca , we love to see the people contributing to open source!

docs is an open project where anyone can create PRs, so feel free to open one if you ever want to contribute

[PiVortex]

Hey @goffxnca - happy for you to contribute this!

What we had in mind was one component that could be inserted anywhere relevant. As you have seen some next steps may be individual to a specific tutorial, I think these should remain but common info can be added to a component.

Initial thoughts of what should be in the component is:
Link to dev telegram https://t.me/neardev
Discord https://discord.gg/nearprotocol
and that we have office hours at 11 AM UTC and 6PM UTC each Thursday on discord

[thisisjoshford]

i'm interested in working on this, could you assign it to me?

saw you mentioned this section should be easy to update in one spot, but looks like there are a few variations across different pages. maybe could craft a single standard texts or paragraph for this section and use it as a component? happy to build it out!

Awesome @goffxnca ! I assigned you this ticket! TYSM!!!

As @PiVortex stated, creating a re-usable component that has clear instructions on how to get support is crucial. One issue we have is that there are MANY ways to get dev support through numerous channels.

Currently we have a TG folder share link that has about 16 dev chats in it for separate areas of focus. See here:
https://t.me/addlist/VWPcqJDOmXdkZTQ5

Devs can find this folder by going to github.com/near and clicking on dev support at the top. Or at the bottom of sections there is a Dev Resources link that takes you here: https://docs.near.org/help and has what looks similar to a mirror of github.com/near (you created this right @bucanero ?)

In an ideal world, chain abstraction docs should link to the Chain abstraction telegram chat at the end of the article and so on for each topic that pertains to a specific channel. However, we could just link everyone to our main near devs TG channel or Discord as our two main points of entry and then direct support traffic from there. A third option is to link to the folder of dev chats but that could be overwhelming to have 16 options (I'm also missing a few that I need admin rights to add)

So... before you start this @gagdiez @frol @bucanero can you chime in on what you think is best here?

I do think we could update the docs.near.org/help page to not just mirror github.com/near but have all the support channels listed (as we started) but include each TG channel and their area of focus with a link to each as well as the giant folder. Perhaps you could start there? I can create a new ticket for that if you like or update this one. Lmk what works best for you!

[thisisjoshford]

Cameron just shared this landing page for TG chats -> https://www.nearbuilders.com/ I've seen this landing page before but it was only build dao related items. Looks like they have more and some might be outdated. IMO I think this could be organized a little better as not to be overwhelming for someone new to try and find where they fit in. Grouping these channels into relevant sections and perhaps listing them in a table would be easier for people. WDYT?

[goffxnca]

hey guys, thx for directions! loving the ideas about improving support channels and resources. i gonna start working on a reusable component with the basic discord, telegram and office hours info based on what’s been discussed so far. if the telegram link for the component changes later I can tweak it along.

My plans:

1. build the new component SupportContact (or better names if you’ve got one!) where it’ll include links to discord telegram and office hours every thursday at 11 AM UTC and 6 PM UTC on discord.
2. update those 7 pages, here i’ll use the new SupportContact component in the Moving Forward sections across those 7 pages where the unique next steps for each article they stay as-is, here at the end of those unique steps, i’ll drop the new SupportContact to display general contact info.

pr is on its way soon, thoughts welcome.

[bucanero]

Devs can find this folder by going to github.com/near and clicking on dev support at the top. Or at the bottom of sections there is a Dev Resources link that takes you here: https://docs.near.org/help and has what looks similar to a mirror of github.com/near (you created this right @bucanero ?)

Correct, I created the help article based on the GitHub page

So... before you start this @gagdiez @frol @bucanero can you chime in on what you think is best here?

I do think we could update the docs.near.org/help page to not just mirror github.com/near but have all the support channels listed (as we started) but include each TG channel and their area of focus with a link to each as well as the giant folder. Perhaps you could start there? I can create a new ticket for that if you like or update this one. Lmk what works best for you!

For sure, I'd go ahead and update the Help page (docs.near.org/help), adding support channels, TG channels, and removing the "Latest release" column or replacing it with a TG channel link. I think we don't need to keep details about the exact latest version, and we can use that space for something more useful like specific support channels for those tools/projects.

Thanks again @goffxnca for your contributions! 👍