Skip to content

marcospinello/talk-ai-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

When AI goes off script - Tales from the docs pipelines

This repository contains the source code for the presentation When AI goes off script - Tales from the docs pipelines by Marco Spinello.

The presentation explores the use of AI in documentation pipelines, highlighting the benefits and drawbacks through real-world examples.

Get started

Prerequisites

To build and view the presentation, you need to have Node.js and npm installed.

Steps

  1. Clone the repository:

    git clone https://github.com/your-username/talk-ai-api-docs.git
    cd talk-ai-api-docs
  2. Install the dependencies:

    npm install
  3. Serve the presentation:

    npm run marp:serve

    This starts a local server at http://localhost:9999 where you can view the presentation.

    The local server watches for changes to the Markdown files and reloads the presentation automatically.

Build

You can build the presentation in HTML, PDF, and PPTX formats:

  • HTML:

    npm run marp:html
  • PDF:

    npm run marp:pdf
  • PPTX:

    npm run marp:pptx

The output files are saved to the output directory.

Author

Marco Spinello

License

This project is licensed under the terms of the LICENSE file.

About

Slides for a lightning talk about the good, the bad, the ugly when automating docs processes with pipelines featuring AI, (REST) APIs and CI/CD GitHub/GitLab pipelines

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors