{"id":16086910,"url":"https://github.com/olekscode/documentationprototype","last_synced_at":"2026-01-30T10:14:35.610Z","repository":{"id":88081392,"uuid":"454037740","full_name":"olekscode/DocumentationPrototype","owner":"olekscode","description":null,"archived":false,"fork":false,"pushed_at":"2022-03-04T16:04:16.000Z","size":1024,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-11T11:41:42.691Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Smalltalk","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/olekscode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-31T14:27:28.000Z","updated_at":"2022-03-07T14:25:05.000Z","dependencies_parsed_at":"2023-05-18T05:00:17.602Z","dependency_job_id":null,"html_url":"https://github.com/olekscode/DocumentationPrototype","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olekscode%2FDocumentationPrototype","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olekscode%2FDocumentationPrototype/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olekscode%2FDocumentationPrototype/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olekscode%2FDocumentationPrototype/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/olekscode","download_url":"https://codeload.github.com/olekscode/DocumentationPrototype/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247353676,"owners_count":20925325,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-09T13:26:04.725Z","updated_at":"2026-01-30T10:14:35.552Z","avatar_url":"https://github.com/olekscode.png","language":"Smalltalk","readme":"# DocumentationPrototype\n\n[![Build status](https://github.com/olekscode/DocumentationPrototype/workflows/CI/badge.svg)](https://github.com/olekscode/DocumentationPrototype/actions/workflows/test.yml)\n[![Coverage Status](https://coveralls.io/repos/github/olekscode/DocumentationPrototype/badge.svg?branch=master)](https://coveralls.io/github/olekscode/DocumentationPrototype?branch=master)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/olekscode/DocumentationPrototype/master/LICENSE)\n\n## How to install it?\n\nTo install `DocumentationPrototype`, go to the Playground (Ctrl+OW) on your [Pharo](https://pharo.org/) image and execute the following Metacello script (select it and press Do-it button or Ctrl+D):\n\n```Smalltalk\nMetacello new\n  baseline: 'DocumentationPrototype';\n  repository: 'github://olekscode/DocumentationPrototype/src';\n  load.\n```\n\n## How to depend on it?\n\nIf you want to add a dependency on `DocumentationPrototype` to your project, include the following lines into your baseline method:\n\n```Smalltalk\nspec\n  baseline: 'DocumentationPrototype'\n  with: [ spec repository: 'github://olekscode/DocumentationPrototype/src' ].\n```\n\nIf you are new to baselines and Metacello, check out the [Baselines](https://github.com/pharo-open-documentation/pharo-wiki/blob/master/General/Baselines.md) tutorial on Pharo Wiki.\n\n## How to use it?\n\n### Adding documentation to classes\n\nAdd a class side method to any of your classes specifying the path to a documentation file or a URL to a raw Markdown documentation. For example:\n\n```Smalltalk\nDocumentationBrowser class \u003e\u003e documentation\n  ^ 'pharo-local/iceberg/olekscode/DocumentationPrototype/README.md'\n```\n\n```Smalltalk\nAILinearRegression class \u003e\u003e documentation\n  ^ 'https://raw.githubusercontent.com/pharo-ai/linear-models-posts/master/understanding-linear-regression.md'\n```\n\n### Adding documentation to methods\n\nYou can also add documentation to specific methods using a pragma:\n\n```Smalltalk\nAIKMeans \u003e\u003e fit: aCollectionOfPoints\n   \u003cdocumentation: 'https://raw.githubusercontent.com/pharo-ai/wiki/master/wiki/Tutorials/clustering-simple-example.md'\u003e\n\n   aCollectionOfPoints ifEmpty: [ ^ self ].\n\n   timesToRun timesRepeat: [ self run: aCollectionOfPoints ].\n\n   \"We keep the best centroids after running the algo n-times\"\n   centroids := bestCentroids.\n   self assignClusterToPoints: aCollectionOfPoints\n```\n\nIf method documentation is not specified, then class documentation will be displayed.\n\n### Browsing documentation\n\nThen right-click on that class or any method in it and click on `Browse documentation`.\n\n![](img/menuClass.png)\n![](img/menuMethod.png)\n![](img/browseDocumentation.png)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folekscode%2Fdocumentationprototype","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Folekscode%2Fdocumentationprototype","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folekscode%2Fdocumentationprototype/lists"}