Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(example): examples overhaul #309

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

Alejandro-Morales
Copy link
Contributor

@Alejandro-Morales Alejandro-Morales commented Apr 5, 2024

No description provided.

@Alejandro-Morales Alejandro-Morales changed the title Feat/examples overhaul feat(refactor): examples overhaul Apr 5, 2024
@Alejandro-Morales Alejandro-Morales changed the title feat(refactor): examples overhaul feat(integration): examples overhaul Apr 5, 2024
@Archento Archento changed the title feat(integration): examples overhaul refactor(example): examples overhaul Apr 8, 2024
Copy link
Contributor

@jrriehl jrriehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good! Some suggestions:

  • It's prettly light on core examples so far. I'd suggest adding at least a basic protocol example here to make sure that is included in the core
  • We discussed adding README.md files to the examples to briefly describe the purpose of each one

@Alejandro-Morales Alejandro-Morales linked an issue Apr 10, 2024 that may be closed by this pull request
4 tasks
@Dacksus
Copy link
Contributor

Dacksus commented May 2, 2024

examples overhaul

  • We should also add a readme to the tortoise integration
  • We should add a brief top-level readme to the examples directory, explaining the separation between agent-core and network, how to navigate/use it

To improve maintainability (no redundancy, single source for documentation/definitions) I would suggest the following:

  • Only include example logic specific descriptions and explanations in the example's readme
  • put all "general" documentation into (a) separate file(s)
  • Link to any "general" description/documentation that is needed for an example (e.g., address, seed, bureau etc. basically everything that also should have a proper docstring)
  • If we switch from markdown to asciidocs we can even do includes to compile standalone files without linking and without copy-and-paste redundancies
  • eventually we should maintain valid, useful and up-to-date docstrings, which should be used to populate any base documentation (e.g., in example readmes or for general api documentation) and additional documentation would only be needed for concepts, architecture descriptions, examples, etc.

@jrriehl
Copy link
Contributor

jrriehl commented May 3, 2024

Good points @Dacksus. Definitely agree with both of the first tasks, and for these:

  • Only include example logic specific descriptions and explanations in the example's readme
  • put all "general" documentation into (a) separate file(s)
  • Link to any "general" description/documentation that is needed for an example (e.g., address, seed, bureau etc. basically everything that also should have a proper docstring)

Are you suggesting to provide links like this for all the relevant objects / concepts: https://fetch.ai/docs/references/uagents/uagents-api/context?

@Dacksus
Copy link
Contributor

Dacksus commented May 6, 2024

@jrriehl yes, I envision the ultimate workflow something like:

  1. maintain all object descriptions in docstrings
  2. automatically populate docs from this codebase
  3. manually add any descriptions for concepts / architecture that is not part of docstrings.
    Though ideally, from a usability perspective, we would use 'includes' not links, i.e., having each description written once and include them in all relevant places so they are displayed as part of the document, but only one place for us to update and maintain these descriptions. Theoretically speaking. Practically, I'm not sure yet about the effort and feasibility (we might at least also need a script to automatically extract all docstrings into a markdown/asciidocs file to reference in the examples readmes)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

examples overhaul
3 participants