Skip to content
This repository has been archived by the owner on Jul 14, 2022. It is now read-only.

API Doc Generation #23

Merged
merged 10 commits into from
Nov 26, 2020
Merged

API Doc Generation #23

merged 10 commits into from
Nov 26, 2020

Conversation

athul
Copy link
Contributor

@athul athul commented Nov 20, 2020 •
edited
Loading

Documentation Generation from hoppscotch-collection.json.

New Command: hopp gen <path to json>

  • Basic FE
  • Markdown Support
  • Better Styling with docsify

@athul
Copy link
Contributor Author

athul commented Nov 22, 2020

Here is a working Demo https://hopp-api1.surge.sh/#/

@athul athul marked this pull request as ready for review November 22, 2020 18:46
@athul
Copy link
Contributor Author

athul commented Nov 22, 2020 •
edited
Loading

https://hopp-docsify.surge.sh

Final Working URL.

liyasthomas
liyasthomas approved these changes Nov 25, 2020
View reviewed changes
Copy link
Member

@liyasthomas liyasthomas left a comment

Choose a reason for hiding this comment

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

LGTM

@athul
Copy link
Contributor Author

athul commented Nov 25, 2020

@joicemjoseph Review

joicemjoseph
joicemjoseph reviewed Nov 25, 2020
View reviewed changes
Copy link
Contributor

@joicemjoseph joicemjoseph left a comment

Choose a reason for hiding this comment

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

@joicemjoseph Review

Will do that in the morning

cli.go Outdated

func initFileSystem(binPath string) (stuffbin.FileSystem, error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

unnecessary here

Copy link
Contributor Author

@athul athul Nov 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I don't think this snippet exists now. I had removed that in 5f9058c

@athul
Copy link
Contributor Author

athul commented Nov 26, 2020

@liyasthomas Merge Cheyyuvaane

@athul athul merged commit 7bc2111 into master Nov 26, 2020
@athul athul deleted the api-gen branch December 8, 2021 05:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@liyasthomas liyasthomas liyasthomas approved these changes

@joicemjoseph joicemjoseph joicemjoseph approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@athul @joicemjoseph @liyasthomas