onebusaway / onebusaway-docs

Official developer documentation for OneBusAway

OneBusAway Developer Documentation

Welcome to the GitHub project that powers the official OneBusAway Developer Documentation.

Improve the Documentation

Want to help improve the documentation? Thank you! You can easily improve the official OneBusAway documentation by modifying the Markdown files that comprise it. We welcome any size of contribution, ranging from typos and corrected links, to brand-new tutorials.

Import Javadocs from OBA Sites

From the root of the project, run the command bin/update_javadocs to see a list of available projects from which Javadocs can be imported.

Develop New Features/Fix Bugs

Prerequisites

Ensure you have the following installed on your system:

• Ruby (version >= 2.7)
• Node.js (version >= 12)
• Yarn

Setting Up Development Environment

For Windows Users (via Windows Subsystem for Linux - WSL)

1. Install the Windows Subsystem for Linux (WSL) if you haven't already.

2. After setting up WSL, navigate to the project directory in your Linux subsystem.

3. Fork the repository by clicking the "Fork" button on the repository page.

4. Clone the forked repository:

   git clone https://github.com/YourUsername/onebusaway-docs.git
   cd onebusaway-docs

5. Install dependencies:

   bundle install
   yarn install

   If you encounter any errors, you may run:

   yarn add glob

6. If CSS is not working properly, rebuild frontend assets:

   bin/bridgetown frontend:build

For Linux Users

1. Fork and clone the repository as described above.

2. Navigate to the project directory.

3. Install dependencies:

   bundle install
   yarn install

Development

To start the site in development mode, run:

bin/bridgetown start

Additional Commands

Load the site up within a Ruby console (IRB)

bin/bridgetown console

Learn more: Bridgetown CLI Documentation

Deployment

The website built from this project is deployed automatically to a static hosting service on Render. Please contact the maintainers with any questions.

Creating an issue.

• Check if the issue you are going to propose is not duplicate of another issue.
• Open a new issue according to type i.e., if issue is a bug open a new issue by clicking on Get Started in the scope of Bug Report.
• Give a precise and meaningful name of the issue.
• Describe your issue as good as possible that may ease the process of issue-reviewing by a community member.

Create a pull request

• Try to keep the pull requests small. A pull request should try its very best to address only a single concern.
• For work in progress pull requests, please use the Draft PR feature.
• Make sure all tests pass and add additional tests for the code you submit.
• Document your reasoning behind the changes. Explain why you wrote the code in the way you did. The code should explain what it does.
• If there's an existing issue, reference to it by adding something like References/Closes/Fixes/Resolves #123, where 123 is the issue number.
• Please fill out the PR Template when making a PR.

Please note: maintainers may close your PR if it has gone stale or if we don't plan to merge the code.

Pull request reviews

• Requested changes must be resolved (with code or discussion) before merging.
• If you make changes to a PR, be sure to re-request a review.
• Don't repeadetely tag someone(may be it is not the right time to review your PR), be patient.
• Do not 'resolve conversation' unnecessary raised by a community member or any workflow tools(codeclimate or hound) as they may have some purpose, try to resolve the request changes and if any help wanted tag a community member to give views about that.

Code Contributors

This project exists because of all the people who have contributed.

The bottom line

We are all humans trying to work together to improve the community. Let's always be kind and appreciate the importance of making compromises. ❤️

onebusaway-docs's Issues

[FEATURE]: Add issue info to improve readability

I'd like to suggest one feature here.
Instead of just showing issue number in /release-notes, we should also append the issue detail that will make it more readable.
It'll help the user to quickly grasp the issue detail instead to checking it again and again on github.

Attaching screenshot for better info:

🐞 Add button title to code block copy buttons

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

In #50, we gained the ability to copy code snippets from blocks throughout the website (thanks @ankitkumar748846!). However, these buttons are not labeled for screenreader. They should be given a title attribute "Copy Code Snippet"

Steps To Reproduce

look at index.js where these buttons are created

Expected Behavior

they should have a title attribute labeled "Copy Code Snippet"

Screenshots

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

No

🐞 Add dark mode support to JSON Editor

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

The new JSONEditor needs support for dark mode

Steps To Reproduce

1. use dark mode
2. open http://localhost:4000/api/where/methods/vehicles-for-agency

Expected Behavior

The JSONEditor's theme does not have a bright, white background, but instead a background that is suitable for use with dark mode.

Screenshots

Device Information [optional]

No response

Additional context

No response

Are you working on this issue?

No

Feature of light and dark mode button

Is your feature request related to a problem? Please describe

• while developing the document website i was getting problem of switching dark and light mode other developers may get that
• better and dynamic user experience

Describe the solution you'd like

Current planning

---

• adding the button for dark and light mode
• at starting website will get loaded in user preference mode and user can change dark and light mode of the website

---

Extra feature may add in future:

1. after changing the mode the mode will get saved in localstorage hence user will get better experience even refreshing the website he/she will get it preferred mode as previously select
2. as user change the its desktop's mode, an event listener will get attached the changing on the changing system mode which will change the mode of the website also

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Investigate using codesandbox.io for hosting interactive API examples

Is your feature request related to a problem? Please describe

it would be nice to have interactive examples either embedded in or linked to the developer docs. https://codesandbox.io offers features that could power this, and they are nice enough to offer non-profits free use of their services.

Describe the solution you'd like

tbd, you figure it out.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

🐞 bug: Sidebar scroll is not functioning properly.

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

The sidebar scroll is not functioning properly, leading to a poor user experience.

Before:

Before.mp4

After:

After.mp4

Steps To Reproduce

1. Navigate to the sidebar.
2. Scroll to the bottom of the sidebar.
3. Click on "vehicleStatus." Note that the scroll bar moves upward, despite clicking at the bottom of the sidebar.

Expected Behavior

When I click on the bottom of the sidebar, the scroll bar should also stay at that position.

Screenshots

No response

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

Yes

Feature: for adding the feature of the togglling nav list of the navbar

Is your feature request related to a problem? Please describe

• in future if content of the document will get increases there will be more number of sections which will cause the much scrolling
• see bellow sample

Describe the solution you'd like

i'm giving just sample what i'm trying to say:

It is just a sample just i started working on it

2024-03-13.15-40-05.mp4

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

🐞 Bug: Add titles to the icons appearing in the footer section.

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

Titles are not available in the icons which are present in the footer section. However, these icons are not labeled for screen-reader.

Steps To Reproduce

1. Go to the footer section of the webpage.
2. Hover on any icon you will find that the icons are not labeled for screen-reader.

Expected Behavior

Add titles to the icons appearing in the footer section.

Before:

After:

Screenshots

No response

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

Yes

Mobile: Navigation pane doesn't appear if you try to show it while scrolled down the page

Repro:

1. Launch the site on a mobile device (or desktop, small viewport)
2. Scroll down to the bottom of a longish page.
3. Tap the hamburger button.

Expected: navigation pane appears.
Actual: navigation pane is not shown, because it's 👆 a few screen lengths away.

The fix should be pretty straightforward: apply position: absolute to the navigation pane on viewports smaller than large.

Dead links to be redirected

Here is a list of broken links that we should look into fixing to make the documentation website better!
I will be looking into fixing these as well.

S no.	Error	URL	Anchor Text	Linked From
1	-1 Invalid URL	http://localhost:8080/	http://localhost:8080/	https://developer.onebusaway.org/guides/quickstart-guide
2	404 Not Found	https://developer.onebusaway.org/oba-configs/index.html	list of configuration parameters	https://developer.onebusaway.org/guides/installation-guide
3	404 Not Found	https://developer.onebusaway.org/guides/sms-webapp-configuration-guide	SMS Config	https://developer.onebusaway.org/guides/installation-guide
4	404 Not Found	https://repo.camsys-apps.com/releases/org/onebusaway/onebusaway-status-agent/2.4.18-cs/onebusaway-status-agent-2.4.18-cs-withAllDependencies.jar	onebusaway-status-agent-2.4.18-cs-withAllDependencies.jar	https://developer.onebusaway.org/downloads
5	404 Not Found	https://repo.camsys-apps.com/releases/org/onebusaway/onebusaway-status-agent/2.4.18-cs/onebusaway-status-agent-2.4.18-cs.jar	onebusaway-status-agent-2.4.18-cs.jar	https://developer.onebusaway.org/downloads
6	-1 Invalid URL	http://localhost:8080/where/standard/agencies.action	http://localhost:8080/where/standard/agencies.action	https://developer.onebusaway.org/guides/troubleshooting-guide
7	-1 Invalid URL	http://localhost:8080/where/standard/	http://localhost:8080/where/standard/	https://developer.onebusaway.org/guides/troubleshooting-guide
8	-1 Invalid URL	http://localhost:8080/where/standard/stop.action?id=AGENCYID_STOPID	http://localhost:8080/where/standard/stop.action?id=AGENCYID_STOPID	https://developer.onebusaway.org/guides/troubleshooting-guide
9	-1 Invalid URL	http://localhost:8080/api/where/agencies-with-coverage.xml?key=TEST	http://localhost:8080/api/where/agencies-with-coverage.xml?key=TEST	https://developer.onebusaway.org/guides/troubleshooting-guide
10	404 Not Found	https://developer.onebusaway.org/api/where/methods/stops.html	method documentation	https://developer.onebusaway.org/guides/troubleshooting-guide
11	-1 Invalid URL	http://localhost:8080/api/where/routes-for-agency/AGENCYID.xml?key=TEST	http://localhost:8080/api/where/routes-for-agency/AGENCYID.xml?key=TEST	https://developer.onebusaway.org/guides/troubleshooting-guide
12	-1 Invalid URL	http://localhost:8080/api/where/stop-ids-for-agency/AGENCYID.xml?key=TEST	http://localhost:8080/api/where/stop-ids-for-agency/AGENCYID.xml?key=TEST	https://developer.onebusaway.org/guides/troubleshooting-guide
13	404 Not Found	https://developer.onebusaway.org/api/where/elements/list-result.html	list result	https://developer.onebusaway.org/api/where/methods/stops-for-location
14	404 Not Found	https://developer.onebusaway.org/api/where/elements/stop.html	<stop/> element	https://developer.onebusaway.org/api/where/methods/stops-for-location
15	-1 Not found: The server name or address could not be resolved	http://user47094.vs.easily.co.uk/siri/	SIRI	https://developer.onebusaway.org/api/where/elements/situation
16	404 Not Found	https://developer.onebusaway.org/guides/wiki/Database-Guide	Database Setup and Configuration Guide	https://developer.onebusaway.org/guides/wiki/oba-1x-developer-guide
17	404 Not Found	https://developer.onebusaway.org/guides/wiki/nextbus.com/xmlFeedDocs/NextBusXMLFeed.pdf	NextBus API	https://developer.onebusaway.org/guides/wiki/gtfs-realtime-resources
18	-1 Invalid URL	http://localhost:8080/onebusaway-transit-data-federation-webapp/	http://localhost:8080/onebusaway-transit-data-federation-webapp/	https://developer.onebusaway.org/guides/wiki/enterprise-webapp-configuration
19	-1 Invalid URL	http://localhost:8080/onebusaway-api-webapp/api/where/config.json?key=TEST	http://localhost:8080/onebusaway-api-webapp/api/where/config.json?key=TEST	https://developer.onebusaway.org/guides/wiki/enterprise-webapp-configuration
20	-1 Invalid URL	http://localhost:8080/routes	http://localhost:8080/routes	https://developer.onebusaway.org/guides/wiki/enterprise-webapp-configuration
21	-1 Invalid URL	http://localhost:8080/api/where/stops-for-location.xml?key=TEST&lat=37.785045&lon=-122.407049	http://localhost:8080/api/where/stops-for-location.xml?key=TEST&amp;lat=37.785045&amp;lon=-122.407049	https://developer.onebusaway.org/guides/wiki/gtfs-realtime-quickstart
22	403 Forbidden	https://camo.githubusercontent.com/75dc67e42c838144f7d5f6f2901461c0272888ab/687474703a2f2f646576656c6f7065722e6f6e65627573617761792e6f72672f6d6f64756c65732f6f6e65627573617761792d6170706c69636174696f6e2d6d6f64756c65732f63757272656e742f6775696465732f517569636b53746172744775692e706e67	img/src	https://developer.onebusaway.org/guides/wiki/gtfs-realtime-quickstart
23	404 Not Found	https://developer.onebusaway.org/modules/onebusaway-application-modules/current/api/where/index.html	REST API [301 from http://developer.onebusaway.org/modules/onebusaway-application-modules/current/api/where/index.html]	https://developer.onebusaway.org/guides/wiki/oba-1x-developer-guide
24	404 Not Found	https://www.mbta.com:443/rider_tools/developers/default.asp?id=21895	MBTA’s GTFS data [301 from http://www.mbta.com/rider_tools/developers/default.asp?id=21895]	https://developer.onebusaway.org/guides/wiki/oba-1x-developer-guide
25	404 Not Found	https://www.mbta.com:443/rider_tools/developers/default.asp?id=22393	MBTA GTFS-realtime [301 from http://www.mbta.com/rider_tools/developers/default.asp?id=22393]	https://developer.onebusaway.org/guides/wiki/oba-1x-developer-guide
26	404 Not Found	https://developer.onebusaway.org/modules/onebusaway-application-modules/current/api/where/methods/stops-for-location.html	stops-for-location [301 from http://developer.onebusaway.org/modules/onebusaway-application-modules/current/api/where/methods/stops-for-location.html]	https://developer.onebusaway.org/guides/wiki/gtfs-realtime-quickstart
27	404 Not Found	https://developer.onebusaway.org/modules/onebusaway-application-modules/current/api/where/methods/arrival-and-departure-for-stop.html	arrivals-and-departures-for-stop [301 from http://developer.onebusaway.org/modules/onebusaway-application-modules/current/api/where/methods/arrival-and-departure-for-stop.html]	https://developer.onebusaway.org/guides/wiki/gtfs-realtime-quickstart
28	404 Not Found	https://github.com/OneBusAway/onebusaway-docker/tree/main/config	Docker repo [302 from https://github.com/OneBusAway/onebusaway-docker/tree/master/config]	https://developer.onebusaway.org/guides/wiki/enterprise-webapp-configuration
29	404 Not Found	https://api.pugetsound.onebusaway.org/api/where/search/route.json?input=crystal&key=TEST	http://api.pugetsound.onebusaway.org/api/where/search/route.json?input=crystal&amp;key=TEST [301 from http://api.pugetsound.onebusaway.org/api/where/search/route.json?input=crystal&key=TEST]	https://developer.onebusaway.org/api/where/search/route

Note: Some of the links are used for explanation purposes. Eg: 1st localhost link is used to demonstrate starting up of the webapp.

Inactive Links on Website

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

Some links on the website are inactive, leading to a poor user experience and potential frustration for users trying to access relevant content. In certain pages of the REST API METHODS, specifically within sections such as "Cancel Alarm" and "Vehicles for Agency," as well as "Arrival and Departure for Stop," inactive links are observed.

Steps To Reproduce

1.Click on the "REST API METHODS" section in the sidebar to access the main section containing various subsections.
2.Within the "REST API METHODS" section, select any of the subsections, such as "cancel-alarm," "vehicles-for-agency," or "arrival-and-departure-for-stop."
3.After clicking on the desired subsection, the page will reload, displaying the content related to that subsection.
4.Within the subsection page, "Sample Request" section.
5.Copy the link associated with the "Sample Request."
6.Open a new tab in your browser (e.g., Google Chrome).
7.Paste the URL

Expected Behavior

http://api.onebusaway.org/api/where/vehicles-for-agency/1.json?key=TEST
https://api.pugetsound.onebusaway.org/api/where/cancel_alarm/1_00859082-9b9d-4f72-a89f-c4be0e2cf01a.json

Screenshots

No response

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

refactor: API Link displayed on the link

Is your feature request related to a problem? Please describe

The API links displayed on the screen do not look good on the webpage.

Before:

After:

Describe the solution you'd like

The problem with the displayed links on the screen is that they do not have an appealing appearance or visual presentation.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

docs: Enhancement in Readme file

Is your feature request related to a problem? Please describe

There is insufficient information available about the community, including how to join Slack and the names of contributors and many more.

Describe the solution you'd like

Detailed information about the OneBusAway Developer is provided in the README.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

GitHub Edit this Page button Hidden on Small Screens

When we resize to small screens, the Edit this Page option hides in the navbar which it shouldn't!

Before:

Recommended changes:

Let me know what are your thoughts on this! I'm happy to work on this issue @aaronbrethorst.

Thanks

🐞 Bug : Missing id to release notes heading

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

The Release Notes heading on the RestFul API page has missing id, and so when we try to copy the heading link we get null

Steps To Reproduce

1. Go to RestFul API page
2. Copy the Release Notes header link
3. Paste it in new tab
4. The pasted contents end with #null

Expected Behavior

When we copy the header link of Release Notes the copied contents should be https://developer.onebusaway.org/api/where#release-notes and not https://developer.onebusaway.org/api/where#null

Screenshots

On pasting the header link

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

Yes

Light Mode Icon in Docs needs to be enhnace for better visibility

Is your feature request related to a problem? Please describe

When the theme is switched to dark mode, the background color of the theme switch button should adapt accordingly instead of remaining white.

Describe the solution you'd like

Now the theme switch button's background color adpats to dark mode when toggled, ensuring interface consistency.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Improvement: Improving the Quickstart guide

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

Currently, If a new user comes to run the OneBusAway application suite, he/she may not find proper data or links to get started like, transit schedule data, the required .war links, etc.

Improvements needed:

• We may include the screenshots after running the app (if necessary).
• Clarified Prerequisites like mentioning the specific version of Java recommended and emphasized the importance of having transit data.
• Add a proper step-by-step guide
• Additional Resources like links to slack channels, etc. for users seeking further assistance.

Steps To Reproduce

Link- https://developer.onebusaway.org/guides/quickstart-guide

Expected Behavior

A new and enhanced quick-start guide is needed for all users who visit the developers docs.

Screenshots

No response

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

Yes

🐞 Bug: height of the left-navbar is small in small width and large height devices

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

since the the content of the left-navbar, get reduced in some previous commit hence the height also get reduced as per the content.

Steps To Reproduce

1. open website in small width of devices
2. open left-navbar by toggling
3. increase the height of the device
4. verify the height of the left-navbar

Expected Behavior

• fix the height to screen height and use y overflow to auto
• please verify the margin and padding also this can hide the content of nav also
• there can be other best solution also

Screenshots

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

No

feat: Create a subsection on the right side of the web page.

Is your feature request related to a problem? Please describe

Lack of subsection on the right side of the web page.

Describe the solution you'd like

Create a subsection on the right side of the webpage that contains all the headings of the page.

Screenshot:

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Addition of "Icon" in footer Section

Previously, our website lacked crucial icons such as "Blog," "Android," and "iOS," which are essential for informing people about our organization.

Attaching screenshot for better info:

I'm currently Working on this issue.

Thanks

feat: Enhancement to the Copy button.

Is your feature request related to a problem? Please describe

Copy Button:

Copy.mp4

Describe the solution you'd like

Made the copy button looks good add the language in code Block.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Feature: Enhance the scrollbar according to docs theme

Is your feature request related to a problem? Please describe

The current scrollbars in the docs don't look good or match the docs theme. To achieve the desired visual consistency and aesthetics across our project, I would like to enhance them across the whole site.

Describe the solution you'd like

Enhancing the scrollbar in the entire docs to the matched theme i.e., dark colors for now.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Feature - Add REST API using Typescript

Is your feature request related to a problem? Please describe

Hi! I want to express my interest in contributing to the One Buy Away project by initiate the REST API client for OBA using Typescript as it said needed in this page..

Please note that this issue may not be a part of the onebusaway-docs' issues. I opened the issue here because I haven't seen any repos related to REST API development, and this repo is the most active with recent updates. I will close the issue if there is a better place to discuss this matter.

Describe the solution you'd like

Project Idea

The vision for this project is to create a comprehensive REST API using TypeScript, with a strong emphasis on type safety and maintainability. I propose to start developing the api using route-controller-service structure with expressJS.

The project structure will look like this:

onebusaway-ts-rest/
├── src/
|   ├── configs/
│   ├── controllers/
│   ├── dtos/
│   ├── interfaces/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── index.ts
├── tests/
│   ├── ...
├── docs/
│   ├── swagger/
│   └── index.html
├── node_modules/
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

I will follow the current response pattern using code, current_time, and data in response body.

{
  "code": 200,
  "currentTime": 1710977677779,
  "data": {
   ...
}

To ensure that only valid data is accepted by the API, I will implement Data Transfer Objects (DTOs) using the Class Validator library. DTOs act as a contract between the client and server, defining the structure and validation rules for incoming data. By validating input at the DTO level, we can prevent invalid data from being processed, thereby enhancing security and reliability.

For fetching data from databases (If OBA using relational db) I propose to use Prisma as the ORM, we can streamline database operations, enhance data modeling, and ensure consistency across data interactions.

To ensure code quality and consistency, I will incorporate ESLint and Prettier into the development workflow. These tools will enforce coding standards, detect potential errors, and automatically format code, contributing to a more maintainable and professional codebase.

I will implement testing using Jest, a popular testing framework for JS and TS. With Jest, we can create unit tests to ensure the functionality of individual components and integration tests to validate the interactions between different parts of the application.

Library docs list:

Library Name	Docs
ExpressJS	https://expressjs.com/
Prisma	https://www.prisma.io/docs
Class Validator	https://github.com/typestack/class-validator
Swagger	https://swagger.io/solutions/api-documentation/
Eslint	https://eslint.org/
Jest	https://jestjs.io/

Additional Ideas

To facilitate ease of use for developers, I propose integrating Swagger for API documentation. This will provide a comprehensive reference for endpoints, request/response payloads, and example usage scenarios, streamlining the onboarding process for new contributor while waiting the docs team completed the integration process.

Note

I really loved to discuss about this project @aaronbrethorst I also have several questions releated to the project.

• Is there any API Spec docs as a brief to the api requirement. Including the header and all the response cases for each route? Or this page could be our references? https://developer.onebusaway.org/api/where
• How api fetch the data? Do the api directly fetch to the data like using ORM to database? If yes, is there any dump data example for testing purposes?

Describe alternatives you've considered

No response

Additional context

If necessary, I would love to provide samples of my code using the proposed patterns. I will deploy the project to my VPS for testing and demonstration purposes.

Are you working on this?

Yes

Addition of "Click to Scroll Top" Button

I'd like to suggest one feature here.
Previously, our website lacked a "click to scroll top" button, which is a crucial user experience feature for navigating long pages.

Attaching screenshot for better info:

I'm currently Working on this issue.

Thanks

🐞 Bug : Scrollbar color not sync with the light and dark mode

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

while changing the light and dark mode: bg-color of the components of scrollbar(scrollbar-track and thumb) not changing for respective mode, as per the media query is applied

Steps To Reproduce

1. launch the website
2. a=notedown the bg-colors of the scrollbar components
3. toggle the mode by clicking on light/dark mode button
4. b=notedown the bg-color of the scrollbar components

Expected Behavior

in above repro
a!=b , which mean the color should be change for the light and dark mode

Screenshots

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

Yes

Bug: Incorrect Position of Copy Code SVG Icon When Horizontal Scrollbar Exists

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

When viewing a code block that requires a horizontal scrollbar due to its length, the copy code SVG icon appears at an incorrect position, causing it to be partially hidden or misaligned. This issue occurs when the code block extends beyond the viewport horizontally.

Steps To Reproduce

1. Navigate to a page containing a code block with long lines of code that require horizontal scrolling.
2. Observe the code block, ensuring that it extends beyond the width of the viewport.
3. Look for the copy code SVG icon associated with the code block.

Expected Behavior

The copy code SVG icon should remain visible and aligned properly (the top position is correct) with the code block, regardless of the presence of a horizontal scrollbar.

Screenshots

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

Yes

Feature: Add a Click to Copy Button for Code

Is your feature request related to a problem? Please describe

It is important to have a "copy" button available on code blocks in the documentation. This will allow users to easily copy the entire code without accidentally leaving any important parts behind.

Describe the solution you'd like

We will use JavaScript to implement the copy functionality throughout the complete documentation, allowing for a specific code block to be copied.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

🐞 Bug : Improper contrast of icons in the footer section in dark mode

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

There's a problem with how bright the icons are at the bottom of the page when we switch to dark mode. They don't get as bright as they should be. But the icons at the top of the page look okay.

Steps To Reproduce

1. Navigate to a page and scroll to the footer section.

Expected Behavior

I thought the icons at the bottom would get brighter so they would look better and be easy to see, especially when we switch to dark mode.

Screenshots

Footer Icons:

Header Icon:

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

Yes

Update the "Configuration and Deployment Guide for v2.x" Document

Is your feature request related to a problem? Please describe

The Configuration and Deployment Guide for v2.x document, which can be found at https://developer.onebusaway.org/guides/wiki/oba-2x-config-deploy-guide, is out of date. For instance, it specifies using JDK 8 even though the latest version of OBA now requires JDK 11.

Describe the solution you'd like

This document needs to be updated to reflect the latest changes to OBA, which can likely be synthesized from the Dockerfile found here: https://github.com/OneBusAway/onebusaway-docker/blob/main/oba/Dockerfile

• The document should mention that unless you have a really good reason for doing it manually, you should be using the official Docker image.
• The download location will need to change. luckily, you can find the latest versions on the downloads page, which will be here on your dev server: http://localhost:4000/downloads
• The data-sources.xml files should mirror the latest changes in the docker repo. Let me know if you have questions about what this should look like.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

feat: Dockerize for easy project setup and development.

Is your feature request related to a problem? Please describe

Currently manually installing and setting up each of the dependencies is bit cumbersome and sometimes have chances of project not running successfully

Describe the solution you'd like

Implement a Docker-based setup for development of the project. This will streamline the setup process, ensuring consistency and reliability across different development environments.

Describe alternatives you've considered

For now only docker setup is done for development environment if required dockerization can be done for production also.

Additional context

No response

Are you working on this?

Yes

bug: Header Link Copying Shows Paragraph Instead of Header Display 🐞

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

After copying the link of the header, the header does not display on the screen; instead, its paragraph displays on the screen.

Steps To Reproduce

1.Navigate to the web-page containing the header link.
2.Copy the link of the header element.
3.Attempt to paste the copied link elsewhere, such as in browser
4.Observe that instead of the header displaying, the paragraph content is displayed .

Expected Behavior

The expected behavior is that it should display all the information, including the heading.

Screenshots

Copy.mp4

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

Yes

🐞 Bug unable to click on the footer links due to the overflow

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

when width of the screen in range of (1537,1772) the footer links (github,blog etc) are not working due to overflow of the right-topbar

Steps To Reproduce

1. launch the website
2. set screen width == 1550px (use dev tool of the browser)
3. scroll to footer
4. click on the icons of footer (github,blog, etc)

Expected Behavior

on clicking links should redirect the user to respective url

Screenshots

Device Information [optional]

- OS:
- Browser:
- version:

Additional context

No response

Are you working on this issue?

No

docs: Sample Response on a Webpage not in a JSON Format

Is your feature request related to a problem? Please describe

The Sample Request that is available is in JSON format but the Sample Response section is not in JSON Format.

Describe the solution you'd like

Sample Request and Sample Response both should be in JSON

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

feat: PR Template

Is your feature request related to a problem? Please describe

Describe the solution you'd like

PR template is designed to facilitate efficient communication processes within our organization. By utilizing this template, we aim to maintain consistency in messaging and branding across all channels. The template outlines a clear structure for organizing information, including headline, subheadings and body content.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Enhancements for Sidebar Functionality

Issue 1 :

The sidebar remains visible even on pages where no content is available, leading to an unnecessary distraction and potential confusion for users.

Issue 2:

Currently, there's no visual indication to signify which item in the sidebar the user has selected, making navigation less intuitive.

Expected Outcome:

1. With the implementation of the first enhancement, the sidebar will be hidden on pages where no content exists, reducing visual clutter and enhancing user focus.
2. The second enhancement will improve navigation usability by highlighting the selected sidebar content, making it easier for users to track their current location within the website.

I am currently working on this.

fix: Inconsistency in documnetation text

Is your feature request related to a problem? Please describe

The problem is that the information in the documents is not consistent. We need to fix this so that everyone can easily read and understand the documents.

Request Parameters on another page:

Describe the solution you'd like

I want to standardize the documentation text by making key points and headings bold for better visibility and importance. Additionally, I'd like to use text boxes to highlight subpoints, improving readability.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Tighten up inter-paragraph padding

The padding in between paragraphs feels unnecessarily generous. Let's decrease it by 25%(?) to increase information density per screen.

Adding a favicon to the website.

Is your feature request related to a problem? Please describe

The website currently lacks a favicon, which is the small icon displayed in the browser tab or next to the website name in bookmarks.

Describe the solution you'd like

Design and Implement a Favicon: Create a favicon.ico file with the desired icon and dimensions (usually 16x16 pixels). This file should be placed in the root directory of the website.

Describe alternatives you've considered

Update HTML Code: Insert the following code within the section of each HTML page to link to the favicon:

Additional context

No response

Are you working on this?

Yes

Feature: Implement Copy Functionality for Direct Links to Specific Headings

Is your feature request related to a problem? Please describe

The current implementation of the Onebusaway Docs lacks a convenient way for users to copy direct links to specific headings within the content.

Describe the solution you'd like

I would like to propose the implementation of a feature that enhances the user experience by providing a seamless way to copy direct links to specific headings within the content using a link icon next to headings. Functionality includes:

• Improved Copy Functionality
• Smooth Scrolling
• Visibility Toggle

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

feat: Issue form for bug and feature template

Created an issue form for both bug and feature template

Attaching screenshot for better info:

I'm currently Working on this issue.

Thanks

Document the config.json API endpoint

A new REST API Methods page should be added for config.json. Here's an example URL: https://api.pugetsound.onebusaway.org/api/where/config.json?&key=TEST

feat: In light mode and dark mode, the Algolia search bar is in light mode.

Is your feature request related to a problem? Please describe

In dark mode, the Algolia search bar should be in dark mode, and in light mode, the Algolia search bar should be in light mode.

Describe the solution you'd like

The Algolia search bar also supports dark mode.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Feature: New README for Windows/Linux Users

Is your feature request related to a problem? Please describe

Currently, Windows contributors are facing difficulties while contributing to this repo, so we need to add the contributing guidelines to the README.md.

Describe the solution you'd like

Provide detailed contribution guidelines in a well-structured Readme file for both Windows and Linux users.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Two scrollbars appear in navigation pane

See the screenshot below:

there should only be a single scrollbar (the right-most one), and the site's title and logo should not scroll out of view when scrolling.

Interested in Contributing to the Developer Documentation Website Enhancement Project during GSOC

Hey @aaronbrethorst,

I am writing to express my strong interest in the Developer Documentation Website Enhancement project at Open Transit Software Foundation as part of Google Summer of Code. After reviewing the project details, I believe my skills and background make me well-equipped to contribute meaningfully to this initiative.

Having previously contributed to the OpenSearch project and Microsoft Learn modules, I have gained valuable experience in open source collaboration and documentation improvement, which I believe aligns well with the goals of this project.

I am particularly drawn to this project due to my passion for ensuring clear and cohesive developer documentation. I am eager to take on the challenge of unifying disparate sources of documentation, refining the website, and creating a seamless pipeline for updating Java API docs.

Issue

Currently, I am experiencing difficulty joining the Slack community due to an error regarding the email domain. I would greatly appreciate any guidance on alternative ways to get involved in the community, access relevant resources, and connect with potential mentors.

I look forward to the opportunity to discuss this project further and to learn more about the next steps in the application process. Your mentorship and insights will be invaluable as I navigate my way through the Open Transit Software Foundation's programs.

Thank you for considering my interest, and I am enthusiastic about the possibility of contributing to this initiative.

Additional context

GSOC

Are you working on this?

Yes

Overflow issue in small width (if width <=433px)

Steps to check issue:

1. launch site, go to mobile view
2. go to the "/release-notes" route of the site (you can go by clicking on the link of navigation pan which is "Release Notes" also)
3. zoom out and scroll down

you will get

Issue: overflow in x

Cause by the long ,non-breaking words in code element

REST API: Let me specify my OBA server and key and have it saved in `localStorage`

Is your feature request related to a problem? Please describe

The links throughout the REST API documentation allow me to click on sample request links that are pointed at the Sound Transit (Seattle metro area) OBA server, and they all have the API key test hardcoded, which regularly gets rate limited.

Describe the solution you'd like

I want to be able to optionally specify my preferred server and API key.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

feat: Prev and Next Buttons for Enhanced Navigation Experience

Is your feature request related to a problem? Please describe

Lack of prev and next buttons: Users must manually navigate, leading to frustration, increased effort, and loss of engagement.

Before:

After:

Describe the solution you'd like

Introduce prev and next buttons: Enhance user experience by providing intuitive navigation, reducing effort, and increasing engagement on the website.

After:

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

Yes

Change the heading link icon to a checkmark after copying

Is your feature request related to a problem? Please describe

In #90, we gained the ability to copy a heading's link to the clipboard by clicking on it. This is a great addition, but it doesn't give the user any feedback that the copy event occurred. After clicking on the icon, the link icon should change to a checkmark, as seen on code snippets.

Describe the solution you'd like

see above

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

Copy button overlapping with the code in code-block

Summary

The "Copy" button is overlapping with the code within the code block, creating usability issues and hindering code readability.

Solution

The solution requires adding padding to the code block, ensuring that the "Copy" button does not overlap with the code, thereby improving usability and code readability.

Desktop view :

Phone view :

Are you working on this ?

Yes